Skip to content

Repository files navigation

Flow UI

Shared design system and component library for Flow applications.

Ships raw TypeScript source — no build step. Your Vite + Tailwind pipeline compiles it.

Installation

bun add @flow-industries/ui

Documentation

Full documentation at docs.flow.industries/en/ui.

Development

bun run dev   # landing page at localhost:5173

Visual regression

CI screenshots the showcase (#design, #showcases, #components in light and dark) against baselines committed under tests/visual.spec.ts-snapshots/ and fails on any diff.

bun run build && bun run test   # compare against baselines (Linux only)
./scripts/update-snapshots.sh   # re-render baselines after an intended visual change (Docker)

Baselines are rendered on Linux inside the pinned Playwright image — a bare macOS run diffs against them spuriously, so always update through the script (or grab the visual-diffs artifact from a failed CI run to inspect changes).

Accessibility

CI also runs axe (tests/a11y.spec.ts) over the same pages and themes, plus each overlay in its open state, failing on serious/critical violations. Genuine findings get fixed or filed against the UI-3 audit — see knownViolations in the spec for the tracked exceptions; allowlistedRules is reserved for documented false positives.

bun run build && bunx playwright test tests/a11y.spec.ts

License

MIT

Contributors

Languages