@zizigy/capsule
v1.1.0
Published
CapsuleUI: Native Web Components, unstyled by design. Build your own design system on a solid foundation. Like shadcn, for the web platform.
Readme
Getting Started
- Initialize global Capsule folder (templates and globals):
npx @zizigy/capsule init
# or choose a custom base directory
npx @zizigy/capsule init --dir ./playground- Add a component (installs into
@capsule/components/<prefix>-<component>):
npx @zizigy/capsule add Slider --prefix uiThis will also:
- Inject component CSS into
@capsule/global.css - Inject component JS into
@capsule/index.js
- Run the playground (Vite):
npm run play
# or
yarn playQuick Preview (Playground)
- Entry HTML:
playground/index.html - Global styles:
playground/@capsule/global.css - Components entry:
playground/@capsule/index.js
Open the dev server and experiment with components right away.
Project Structure
src/@template/— template used bycapsule init@capsule/— generated global folder in your project (globals + components)global.css— global CSS variables, resets and component importscomponents/init.js— entry point that imports all installed componentscomponents/<prefix>-<component>/— individual component source
public/— static assets (e.g. images)playground/— local demo environment
Commands
npx @zizigy/capsule init [-d, --dir <dir>]— create@capsulefolder from templatecapsule add <Component> [-p, --prefix <prefix>] [-m, --minify]— install a componentnpm run play— run Vite dev server forplayground
License
MIT
