Source repository for Flux UI — an opinionated component library for Vue 3 and React.
Documentation, live examples, and the component API reference live at flux-ui.dev.
This is a Bun workspaces monorepo. All packages are published under the @flux-ui scope.
| Package | Description |
|---|---|
@flux-ui/components |
Main component library. |
@flux-ui/types |
Public TypeScript types (no build step). |
@flux-ui/internals |
Shared composables, utilities, and directives. |
@flux-ui/statistics |
Chart components built on Apache ECharts. |
@flux-ui/application |
Application shell components. |
@flux-ui/ai |
AI conversation and streaming components. |
@flux-ui/flow |
Node and edge editor components. |
@flux-ui/visuals |
Visual annotation and effect components. |
@flux-ui/react |
Native React component library. |
- Bun >= 1.2.13
- Node.js >= 23
- A FontAwesome Pro npm token in the
FONTAWESOME_NPM_AUTH_TOKENenvironment variable (configured via the root.npmrc).
- Clone the repository.
- Run
bun installin the project root. - Build all publishable packages with
./build.sh, or build a single package withbun run --cwd packages/<name> build.
The documentation site can be developed against the local packages with bun run --cwd docs dev.
All commit messages and branch names are in English.
- main — Latest stable release; matches what is running in production.
- develop — Latest staging release; matches what is running on staging.
- Feature branches — Each feature gets its own branch. Merge into
developonce complete, then delete the branch. - Bugfix branches — Each bug fix gets its own branch. Merge into
developonce complete, then delete the branch.
Commit messages follow Conventional Commits:
<type>: <message><type>(<scope>): <message><type>(<scope>): <message> [<issue-number>]
Examples:
feat(expandable): adds header slot to expandable.feat(expandable): adds header slot to expandable. [FLUX-123]chore: adds vue 3 build target.