Skip to content

Latest commit

 

History

History
90 lines (67 loc) · 2.95 KB

README.md

File metadata and controls

90 lines (67 loc) · 2.95 KB
Raw

Logo

Radix Vue

An unofficial Vue port of Radix UI.
Radix is an unstyled, customisable UI Library with built in accessibility for building top quality design systems.

NPM version NPM Downloads GitHub stars

Get involved!

Documentation | Getting Started | Examples | Why Radix Vue?

hero image design by: icarusgkx, melkam

Installation

pnpm add radix-vue
npm install radix-vue
yarn add radix-vue

Documentation

For full documentation, visit radix-vue.com.

Releases

For changelog, visit releases.

Contributing

We would love to have your contributions! All PRs all welcomed! We need help building the core components, docs, tests, stories! Join our discord and we will get you up and running!

Dev Setup

Docs

  1. Clone the repo
  2. Run pnpm i
  3. Run pnpm build to run build radix-vue locally
  4. Run pnpm docs:dev to run vitepress
  5. Open http://localhost:5173

Package

  1. Clone the repo
  2. Run pnpm i
  3. Run pnpm story:dev to run histoire (storybook)
  4. Open http://localhost:6006

Authors

Credits

All credits go to these open-source works and resources

  • Radix UI for doing all the hard work to make sure components are accessible
  • Floating UI for creating powerful components that as the base of many Radix Vue components
  • VueUse for providing many useful utilities.
  • Ark UI for the <Primitive> component
  • Radix Svelte
  • Headless UI