@nodecraft/ui

Nodecraft UI

Usage no npm install needed!

<script type="module">
  import nodecraftUi from 'https://cdn.skypack.dev/@nodecraft/ui';
</script>

README

ui

UI Project

https://www.notion.so/nodecraft/Auto-UI-Project-Scope-0758b331766a4472b1f6e56c015613ef

Installation

  • Ensure you are logged into npm with an account that has access to @nodecraft scoped packages. npm login
  • Make sure you're using NPM 6 (not NPM 7). At time of writing, the latest v6 is 6.14.13.
  • Run npm ci to install all needed packages

Usage

External

We export all of our .vue Single File Components, as well as some validation helpers for external use.

  • Ensure you have the following peer dependencies installed in your project (as dev dependencies). These are not included in the bundle, so the parent project can control how they're bundled, etc.. It's the parent project's responsibility to handle the importing/bundling of things like CSS, SVG, etc.
    • @nodecraft/icons
    • core-js
    • tailwindcss
    • vue (3+)
import '@nodecraft/ui/dist/style.css'; // loads all needed CSS. Make sure you load Tailwind with @nodecraft/tailwind-base first to get all of our colors, etc.
import NCButton from `@nodecraft/ui`;
// do vue things with this component

Storybook

  • npm run storybook

Deploy