Skip to content

Repository files navigation

Auron UI

npm versionlicenseCIstorybook

A multi-framework component library — accessible, beautifully designed UI components powered by Reka UI and Tailwind CSS 4. Starting with Vue 3, with React and Angular coming soon.

Inspired by HeroUI.

Features

  • 90+ components — covering every UI domain: forms, overlays, navigation, data, date/time, color, and more
  • Accessible by default — every component passes @chialab/vitest-axe with zero violations
  • Reka UI primitives — battle-tested WAI-ARIA state machines (Radix for Vue) under the hood
  • Tailwind CSS 4@auronui/styles ships BEM class strings via tailwind-variants, fully themeable
  • Vue 3.5+ native — uses useTemplateRef, improved defineModel, and useId throughout
  • Tree-shakablesideEffects: false; only the components you import land in your bundle
  • SSR-safe — every component renders in Nuxt 3 with zero hydration mismatches
  • TypeScript strict — full prop and slot type inference, JSDoc-driven props tables in docs

Installation

pnpm add @auronui/vue
// main.tsimport'@auronui/vue/style'

Peer dependencies: vue@^3.5.0, reka-ui@^2.9.0.

AI Assistant Setup

AuronUI ships rules that teach AI coding assistants (Claude Code, Cursor, Copilot, Windsurf, Gemini CLI, etc.) to use <Button> instead of <button>, import from @auronui/vue, and follow the component API correctly.

npx @auronui/vue setup-ai

This creates auronui-rules.md in your project root and prints the one-liner to add to each AI tool's config file. Re-run with --update after upgrading the package to refresh the rules.

The rules are generated from the library source on every build — the component roster, prop names and accepted variant/color/size values are read out of packages/vue/src and packages/styles/src, so they cannot drift from the code. See packages/vue/src/ai-rules/: template.md holds the prose and hand-written examples, extract.mjs reads the API surface, and generate.mjs merges the two and fails the build when an example contradicts the code.

Quick Example

<script setup lang="ts">import { Button, ButtonGroup } from'@auronui/vue'</script>
<template>
<ButtonGroup variant="solid" color="primary">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup>
</template>

Documentation

Browse interactive component stories at Storybook.

Components

DomainComponents
PresentationalSpinner, Separator, Skeleton, Text, Label, Description, Header, Badge, Chip, Surface, Card, Kbd, EmptyState
Buttons & LinksButton, ButtonGroup, CloseButton, ToggleButton, ToggleButtonGroup, Link
FormsForm, FormField
Form InputsInput, Textarea, NumberField, Fieldset, Editable
Form SelectionCheckbox, CheckboxGroup, Radio, RadioGroup, Switch, SwitchGroup, InputOTP
OverlayPopover, Tooltip, Modal, AlertDialog, Drawer, HoverCard
NavigationTabs, Accordion, Collapsible, Breadcrumbs, Toolbar, NavigationMenu
FeedbackAlert, Toast
SelectionListBox, Select, Dropdown, ComboBox, Autocomplete, ContextMenu, Menubar
DataTable, Pagination
MediaAvatar, AvatarGroup, Slider, ProgressBar, ProgressCircle, Meter, ScrollShadow, ScrollArea
Date & TimeCalendar, RangeCalendar, CalendarYearPicker, MonthPicker, MonthRangePicker, YearRangePicker, DateInput, DateRangeField, TimeField, TimeRangeField, DatePicker, DateRangePicker, DateTimePicker, TimePicker
ColorColorArea, ColorSlider, ColorField, ColorSwatch, ColorSwatchPicker, ColorInputGroup, ColorPicker
ExtendedAspectRatio, Splitter, Stepper, Tree

Project Structure

This is a pnpm + Turborepo monorepo:

auron/
packages/
vue/ # @auronui/vue — Vue 3 component library
styles/ # @auronui/styles — CSS + tailwind-variants (framework-agnostic)
standard/ # shared ESLint/Prettier/TSConfig
vitest/ # shared Vitest config
storybook/ # Storybook 10 dev environment
apps/
docs/ # VitePress documentation site
ssr-test/ # Nuxt 3 SSR smoke test
tree-shaking-test/ # Vite consumer tree-shaking verification

Roadmap

  • @auronui/vue — Vue 3 (current)
  • @auronui/react — React 19
  • @auronui/angular — Angular 18+

Contributing

See CONTRIBUTING.md for monorepo setup, adding a component, and the PR process. All contributors are expected to follow the Code of Conduct.

License

MIT © Auron UI contributors.

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages