Lumia UI Kit

A modern 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. | | 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/ui

Peer dependencies

• React ≥ 18.0 < 20 (^18 || ^19)

🚀 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:

npm run storybook
open http://localhost:6006

The public Storybook for the latest release lives at https://ui.lumiastream.com.

🏗️ Building from source

# clone & bootstrap
npm install

# compile library (ESM + CJS + types)
npm run build

Artifacts land in dist/ and are what gets published to npm.

🤝 Running live

1. Run npm run storybook for hot‑reloading Storybook and npm run watch for the library bundle.
2. Commit with Conventional Commits (feat:, fix: …) so the release pipeline can auto‑generate changelogs.

Running live inside other repos

To iterate on this library against a real consumer (Overlay-UI or LumiaStream) without publishing a new npm version each time, see LOCAL_DEV.md. It covers the symlink workflow for both npm (Overlay-UI) and npm (LumiaStream), the Vite config requirements that have to stay in place for the symlinked workflow to work, and a troubleshooting table for the symptoms we've hit in practice.

🪪 License

ISC © Lumia Stream LLC