@kitelus/fly-ui
v0.1.4
Published
Fly UI - isolated React component library with modern Storybook docs
Readme
FlyUI
Lightweight React component library focused on loading UX with isolated styles and Storybook-driven documentation.
Links
- GitHub: https://github.com/kitelus/fly-ui
- npm: https://www.npmjs.com/package/@kitelus/fly-ui
- Storybook Docs: https://kitelus.github.io/fly-ui/
Features
- Isolated component styles via CSS Modules (prefixed classes)
- Loading-focused UI components for product consistency
- Global + per-component theming support
- Storybook docs and usage playground
- ESM + CJS + TypeScript declarations build output
Components
KiteLogoKiteLoaderKitePageLoaderLoading
Installation
npm install @kitelus/fly-uiQuick Start
import { KiteLogo, KiteLoader, KitePageLoader, Loading } from "@kitelus/fly-ui";
export function Example() {
return (
<div>
<KiteLogo size="md" name="Fly" subBrand="UI" />
<KiteLoader showBrand label="Loading section..." />
<Loading />
<KitePageLoader message="Preparing workspace..." />
</div>
);
}Development
npm install
npm run devRun Storybook:
npm run storybookBuild the package:
npm run build:libBuild static Storybook for GitHub Pages:
npm run build-storybookContributing
Contributions are welcome.
- Fork the repository
- Create your feature branch
- Commit your changes with clear messages
- Open a pull request
Please include a clear description of the change and update docs/stories when relevant.
See detailed guidelines in CONTRIBUTING.md.
Community
- Code of Conduct: CODE_OF_CONDUCT.md
- Contributing Guide: CONTRIBUTING.md
- Security Policy: SECURITY.md
License
This project is licensed under the MIT License. See LICENSE for full details.
Contact
- Maintainer: Binh Tran
- Email: [email protected]
