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…

Что это такое?Headless UI — это набор полностью нестилизованных и при этом полностью доступных UI-компонентов, созданных командой Tailwind Labs так, чтобы они идеально сочетались с Tailwind CSS.
Это для React, Vue или для обоих?Для обоих, через отдельные npm-пакеты: @headlessui/react для приложений на React и @headlessui/vue для приложений на Vue. Также публикуется третий пакет — @headlessui/tailwindcss.
Как добавить его в свой проект?Установите пакет для своего фреймворка: npm install @headlessui/react@latest или npm install @headlessui/vue@latest. Полная документация находится на headlessui.com.
Обязательно использовать вместе с ним Tailwind CSS?Компоненты созданы так, чтобы идеально сочетаться с Tailwind CSS. Поскольку они поставляются вообще без стилей, весь внешний вид вы описываете сами — Tailwind просто напрашивается в пару.
Можно ли безопасно использовать insiders-сборку в продакшене?Стабильными считайте релизные версии; insiders-сборка следует за последним коммитом в ветке main, не придерживается semver, и её API могут измениться до официального релиза.
Придётся ли самому заниматься поддержкой клавиатуры и ARIA-атрибутами?Нет — доступность здесь главная фишка: компоненты полностью доступны сразу из коробки, так что фокус и работа с клавиатурой уже обработаны, а вам остаётся только оформление.
Зачем выбирать нестилизованные компоненты вместо готового UI-кита?Вы сохраняете полный контроль над разметкой и внешним видом — оформляете всё своими классами Tailwind — а библиотека по-прежнему берёт на себя доступное поведение.
Это устоявшийся проект или новый эксперимент?Проект вполне устоявшийся: он размещён в GitHub-организации tailwindlabs, развивается с 2020 года и собрал около 28 800 звёзд.
Size
6.9 MB
Stars
28.8K
Age
6y
Commits · 90 Days