@lumiastream/ui
v0.0.6
Published
Lumia UI Kit
Readme
Lumia UI Kit
A modern, Tailwind‑powered component library used across the Lumia Stream ecosystem. It provides production‑ready React components, design tokens, and Storybook documentation—all published as @lumiastream/ui.
✨ Features
| Feature | Details |
| --------------------- | ----------------------------------------------------- |
| React 18 → 19 | Built and typed for the latest React majors. |
| Tailwind CSS 4 | Utility‑first styling with full theme access. |
| TypeScript first | 100 % typed public API (.d.ts included). |
| Storybook 9 | Live docs with interactive playgrounds & a11y checks. |
| ESM + CJS bundles | Works in every modern build tool. |
🔧 Installation
npm i @lumiastream/uiPeer dependencies
- React ≥ 18.0 < 20 (
^18 || ^19)- Tailwind CSS is already compiled—you do not need Tailwind in the host app unless you want to extend the theme.
🚀 Quick Start
// App.tsx
import { LSButton } from "@lumiastream/ui";
export default function App() {
return <LSButton variant="primary" label="Click Me" />;
}📚 Storybook Docs
Run a fully interactive playground locally:
pnpm storybook
open http://localhost:6006The public Storybook for the latest release lives at https://ui.lumiastream.com.
🏗️ Building from source
# clone & bootstrap
pnpm install
# compile library (ESM + CJS + types) and Tailwind sheet
pnpm buildArtifacts land in dist/ and are what gets published to npm.
🤝 Running live
- Run
pnpm storybookfor hot‑reloading Storybook andpnpm watchfor the library bundle. - Commit with Conventional Commits (
feat:,fix:…) so the release pipeline can auto‑generate changelogs.
🪪 License
ISC © Lumia Stream LLC
