@steez-ui/ui
v0.1.21
Published
React primitives authored with CSS modules for Steez UI.
Downloads
2,319
Readme
Steez UI
Standalone React primitives, flat theme tokens, and shadcn-compatible registry output.
Overview
Steez UI is authored once and shipped in two forms:
- npm packages for direct React consumption
- generated registry payloads for source-level installation
The source of truth lives in packages/ui. The registry output is generated from that same source tree, so the package build and registry install path stay aligned.
Live surfaces:
- Registry frontend:
https://steez-ui-6v5.pages.dev - Docs:
https://steez-ui-6v5.pages.dev/docs/ - Components:
https://steez-ui-6v5.pages.dev/components/ - Packages:
https://steez-ui-6v5.pages.dev/packages/ - Registry page:
https://steez-ui-6v5.pages.dev/registry/ - Registry index:
https://steez-ui-6v5.pages.dev/r/index.json - Foundation preset:
https://steez-ui-6v5.pages.dev/r/foundation.json
Packages
@steez-ui/themeTheme tokens and compatibility aliases.@steez-ui/iconsShared icon surface and provider.@steez-ui/uiReact primitives authored in.tsxand.module.css.
Install
Registry:
bunx shadcn@latest add https://steez-ui-6v5.pages.dev/r/foundation.jsonPackages:
bun add @steez-ui/theme @steez-ui/icons @steez-ui/uiRepo Layout
packages/
theme/ # tokens and compatibility exports
icons/ # icon primitives and provider
ui/ # canonical component source
apps/
registry/ # public install frontend and registry docsAuthoring Model
packages/themedefines tokens first.packages/iconsowns the shared icon surface.packages/uiis the canonical primitive source.scripts/generate-registry.mjsemits the registry JSON payloads from package source.apps/registryis the documentation, preview, and install frontend.
Development
bun install
bun run build
bun run test
bun run test:install-smokeUseful commands:
bun run generate:registrybun run generate:component-pagesbun run check:releasebun run publish:packages:dry-runbun run publish:packagesbun run deploy:registry
Adding Or Updating A Primitive
- Build or update the component in
packages/ui/src/components. - Export it from
packages/ui/src/index.ts. - Add or update the registry item definition in
scripts/generate-registry.mjs. - Add or update the docs metadata and preview in
apps/registry/src/components-docs/. - Run
bun run buildandbun run test. - Confirm the registry frontend reflects the new component or install path.
Release Flow
bun run check:releasebun run publish:packagesbun run deploy:registry
GitHub Actions mirror the same CI, npm publish, and Cloudflare Pages deploy path.
Current Packages
@steez-ui/[email protected]@steez-ui/[email protected]@steez-ui/[email protected]
External Setup
- Add
NPM_TOKENto the GitHub repository secrets before using the package publish workflow. - Add
CLOUDFLARE_API_TOKENandCLOUDFLARE_ACCOUNT_IDto the GitHub repository secrets before relying on the Pages deploy workflow. - Keep the Cloudflare Pages project named
steez-uiso the deploy script and workflow stay in sync.
