primitives README

The project's README from github.com/radix-ui/primitives. As one markdown file: README.md.

Radix Primitives Logo

Radix Primitives

An open-source UI component library for building high-quality, accessible design systems and web apps.

Radix Primitives is a low-level UI component library with a focus on accessibility, customization and developer experience. You can use these components either as the base layer of your design system, or adopt them incrementally.


Installation

First, install pnpm if you haven't already. Open your terminal and run:

npm install -g pnpm

Then, install the dependencies:

pnpm install

Documentation

For full documentation, visit radix-ui.com/primitives/docs.

Releases

For changelog, visit radix-ui.com/primitives/docs/overview/releases.

Contributing

Please follow our contributing guidelines.


Community

Thanks

Chromatic

Thanks to Chromatic for providing the visual testing platform that helps us review UI changes and catch visual regressions.


License

Licensed under the MIT License, Copyright © 2022-present WorkOS.

primitives (radix-ui/primitives)

radix-ui
Searching Database…

What is this?Radix Primitives is an open-source UI component library for building high-quality, accessible design systems and web apps, maintained by WorkOS.
Is it a UI kit with ready-made styled components, or something lower-level?Lower-level: it is a component library focused on accessibility, customization and developer experience, meant to be the base layer you build and style your design system on, not a set of finished widgets.
How do I get it into my project?Full component documentation and usage live at radix-ui.com/primitives/docs. The install steps in the README (install pnpm, then install the dependencies) are for working on the repository itself.
Does it only work with React?Yes — it is a React component library, written in TypeScript.
Do I have to rebuild my whole UI around it, or can I adopt it piece by piece?You can adopt it incrementally — pull in individual components as you need them, or take the whole set as the base layer of a new design system.
Can I use it in commercial projects, and what does it cost?It is free and MIT-licensed, so commercial use is fine; the copyright is held by WorkOS.
Is this a mature project I can rely on?Yes. It has been around since 2020, has about 19.4k GitHub stars, is maintained by WorkOS, and the repo runs CI with unit tests, Playwright e2e and Chromatic visual regression checks.
Can I preview the components before adopting them?Yes — the repo includes a Storybook you can run locally, and the official documentation with the component reference lives at radix-ui.com/primitives/docs. There is also a community Discord for questions and tips.
Creator
radix-ui
Size
23.7 MB
Stars
19.4K
Updated
CommitOct 14
Age
6y
Commits · 90 Days