diff --git a/README.md b/README.md index 9c8017d..ad24fa8 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,11 @@ You can install the insiders version (which points to whatever the latest commit ## Packages -| Name | Version | Downloads | -| :------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------: | -| [`@headlessui/react`](https://github.com/tailwindlabs/headlessui/tree/main/packages/%40headlessui-react) | [![npm version](https://img.shields.io/npm/v/@headlessui/react.svg)](https://www.npmjs.com/package/@headlessui/react) | [![npm downloads](https://img.shields.io/npm/dt/@headlessui/react.svg)](https://www.npmjs.com/package/@headlessui/react) | -| [`@headlessui/vue`](https://github.com/tailwindlabs/headlessui/tree/main/packages/%40headlessui-vue) | [![npm version](https://img.shields.io/npm/v/@headlessui/vue.svg)](https://www.npmjs.com/package/@headlessui/vue) | [![npm downloads](https://img.shields.io/npm/dt/@headlessui/vue.svg)](https://www.npmjs.com/package/@headlessui/vue) | +| Name | Version | Downloads | +| :------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------: | +| [`@headlessui/react`](https://github.com/tailwindlabs/headlessui/tree/main/packages/%40headlessui-react) | [![npm version](https://img.shields.io/npm/v/@headlessui/react.svg)](https://www.npmjs.com/package/@headlessui/react) | [![npm downloads](https://img.shields.io/npm/dt/@headlessui/react.svg)](https://www.npmjs.com/package/@headlessui/react) | +| [`@headlessui/vue`](https://github.com/tailwindlabs/headlessui/tree/main/packages/%40headlessui-vue) | [![npm version](https://img.shields.io/npm/v/@headlessui/vue.svg)](https://www.npmjs.com/package/@headlessui/vue) | [![npm downloads](https://img.shields.io/npm/dt/@headlessui/vue.svg)](https://www.npmjs.com/package/@headlessui/vue) | +| [`@headlessui/tailwindcss`](https://github.com/tailwindlabs/headlessui/tree/main/packages/%40headlessui-tailwindcss) | [![npm version](https://img.shields.io/npm/v/@headlessui/tailwindcss.svg)](https://www.npmjs.com/package/@headlessui/tailwindcss) | [![npm downloads](https://img.shields.io/npm/dt/@headlessui/tailwindcss.svg)](https://www.npmjs.com/package/@headlessui/tailwindcss) | ## Community diff --git a/packages/@headlessui-tailwindcss/README.md b/packages/@headlessui-tailwindcss/README.md new file mode 100644 index 0000000..c3b4584 --- /dev/null +++ b/packages/@headlessui-tailwindcss/README.md @@ -0,0 +1,83 @@ +

+ @headlessui/tailwindcss +

+ +

+ A complementary Tailwind CSS plugin for Headless UI +

+ +

+ Total Downloads + Latest Release + License +

+ +## Installation + +```sh +npm install @headlessui/tailwindcss +``` + +```js +// tailwind.config.js +module.exports = { + content: [], + theme: { + extend: {}, + }, + plugins: [ + require('@headlessui/tailwindcss') + + // Or with a custom prefix: + require('@headlessui/tailwindcss')({ prefix: 'ui' }) + ], +} +``` + +## Documentation + +Use Tailwind CSS utilities for styling the components based on their state. You can use the +following variants: + +| Variant | Inverse variant | +| ------------- | ----------------- | +| `ui-open` | `ui-not-open` | +| `ui-checked` | `ui-not-checked` | +| `ui-selected` | `ui-not-selected` | +| `ui-active` | `ui-not-active` | +| `ui-disabled` | `ui-not-disabled` | + +Example: + +```js +import { Menu } from '@headlessui/react' + +function MyDropdown() { + return ( + + More + + + + Account settings + + + {/* ... */} + + + ) +} +``` + +## Community + +For help, discussion about best practices, or any other conversation that would benefit from being searchable: + +[Discuss Headless UI on GitHub](https://github.com/tailwindlabs/headlessui/discussions) + +For casual chit-chat with others using the library: + +[Join the Tailwind CSS Discord Server](https://discord.gg/7NF8GNe)