@flux-ui/components
v3.5.1
Published
A set of opiniated UI components.
Maintainers
Readme
@flux-ui/components
The main component library of Flux UI — an opinionated set of UI components for Vue 3.
Documentation lives at flux-ui.dev. This readme covers building the package locally.
Highlights
- 100+ Vue 3 components built with
<script setup lang="ts">. - CSS Modules with shared design tokens (palette scales, semantic surfaces, focus rings).
- Programmatic helpers:
showAlert,showConfirm,showPrompt,showSnackbar. - Public composables:
useBreakpoints,useDisabled. - FontAwesome Pro icons (registered through
fluxRegisterIcons).
⭐️ Prerequisites
- Bun >= 1.2.13
- Node >= 23
- A FontAwesome Pro npm token in
FONTAWESOME_NPM_AUTH_TOKEN(see the root.npmrc).
🚀 Getting started
- Make sure the Flux monorepo is checked out.
- Run
bun installin the project root. - Run
bun run --cwd packages/components buildto build the package (runsvue-tscthenvite build). - To link Flux globally with Bun, run
bun link --cwd packages/components.- In another project, use
link:@flux-ui/componentsas the dependency version inpackage.json.
- In another project, use
📦 Sibling packages
@flux-ui/types— public TypeScript types.@flux-ui/internals— shared composables, utilities, and directives.@flux-ui/statistics— chart components built on Apache ECharts.@flux-ui/application— application shell components.
