@zaklad/ui
v0.9.20
Published
Democratised design system runtime. Factory-based components (createButton, createCheckbox, ...) + ZakladProvider. Powered by Tamagui.
Downloads
1,615
Readme
@zaklad/ui
The runtime library for design systems generated by Zaklad.
This package is a managed dependency
You do not install or import @zaklad/ui directly.
When you generate a design system package on Zaklad, the output is a private npm package scoped to your organisation — for example @acme/design-system. That package depends on @zaklad/ui at an exact pinned version matching the Zaklad release it was built against. Installing your generated package pulls in @zaklad/ui automatically.
# What you install (npm / yarn / pnpm / bun — whichever your project uses):
npm install @acme/design-system
# @zaklad/ui arrives as a dependency — you never reference it yourself.Your generated package re-exports everything you need — components, the provider, tokens, hooks — under your own namespace. If @zaklad/ui ever appears in your imports, something has gone wrong.
What this library does
@zaklad/ui provides the factory functions that turn a Zaklad design system configuration into fully working React and React Native components. It is the runtime half of the design-system split:
- Your generated package supplies the data — tokens, themes, text styles, icon sets, component configs.
@zaklad/uisupplies the factories —createButton,createText,createInput, and 24 others — that bind that data into components at startup.
Factories run once when your app initialises. The resulting components are plain React components — no Zaklad-specific props, no vendor lock-in at the call site.
Updating
When Zaklad publishes a new platform version, regenerate your design system package from your Zaklad project. The new tarball will pin to the matching @zaklad/ui version automatically. Run npm install to pull it in.
You do not need to update @zaklad/ui manually. Version alignment is managed by the platform. Run your package manager's install command (npm install, yarn, pnpm install, bun install) after downloading the new tarball.
License
MIT. See LICENSE.
@zaklad/ui is the open runtime. The design system data your organisation generates through Zaklad is licensed separately — see your generated package's LICENSE file for the terms that apply to your tier.
Links
- Platform: zaklad.app
- Support: [email protected]
