headlessui README

The project's README from github.com/tailwindlabs/headlessui. As one markdown file: README.md.

Headless UI

A set of completely unstyled, fully accessible UI components, designed to integrate beautifully with Tailwind CSS.


Documentation

For full documentation, visit headlessui.com.

Installing the latest version

You can install the latest version by using:

Installing the insiders version

You can install the insiders version (which points to whatever the latest commit on the main branch is) by using:

Note: The insiders build doesn't follow semver and therefore doesn't guarantee that the APIs will be the same once they are released.

Packages

Name Version Downloads
@headlessui/react npm version npm downloads
@headlessui/vue npm version npm downloads
@headlessui/tailwindcss npm version npm downloads

Community

For help, discussion about best practices, or feature ideas:

Discuss Headless UI on GitHub

Contributing

If you're interested in contributing to Headless UI, please read our contributing docs before submitting a pull request.

headlessui (tailwindlabs/headlessui)

Searching Database…

What is this?Headless UI is a set of completely unstyled, fully accessible UI components designed to integrate beautifully with Tailwind CSS, built by the Tailwind Labs team.
Is this for React, Vue, or both?Both, via separate npm packages: @headlessui/react for React apps and @headlessui/vue for Vue apps. A third package, @headlessui/tailwindcss, is also published.
How do I add it to my project?Install the package for your framework: npm install @headlessui/react@latest or npm install @headlessui/vue@latest. Full documentation lives at headlessui.com.
Do I have to use Tailwind CSS with it?The components are designed to integrate beautifully with Tailwind CSS. Since they ship with zero styles, you describe the entire look yourself — Tailwind is just the natural pairing.
Is the insiders build safe to use in production?Treat released versions as stable; the insiders build tracks the latest commit on main, doesn't follow semver, and its APIs can change before an official release.
Do I have to handle keyboard support and ARIA attributes myself?No — accessibility is the headline feature: components are fully accessible out of the box, so focus and keyboard behavior are handled while you only take care of styling.
Why would I pick unstyled components over a pre-styled UI kit?You keep full control of the markup and look — styling everything with your own Tailwind classes — while the library still handles the accessible behavior for you.
Is this an established project or a new experiment?It is well established: hosted under the tailwindlabs GitHub organization, developed since 2020, with roughly 28,800 stars.
Size
6.9 MB
Stars
28.8K
Age
6y
Commits · 90 Days