Robin Malfait
0a39cf6b22
* add redent function when verifying snapshots This allows us not to care about the correct amount of spaces and always produces a clean output. * make the container the parent of the wrapper element * drop the visible prop on the Portal component * drop visible prop on Portal component + Also cleanup a little bit * expose the RenderStrategy * implement Transition component in Vue * expose Transition component * add Transitions to the Dialog example
55 lines
2.0 KiB
Markdown
55 lines
2.0 KiB
Markdown
<h3 align="center">
|
|
@headlessui/vue
|
|
</h3>
|
|
|
|
<p align="center">
|
|
A set of completely unstyled, fully accessible UI components for Vue 3, designed to integrate
|
|
beautifully with Tailwind CSS.
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://www.npmjs.com/package/@headlessui/vue"><img src="https://img.shields.io/npm/dt/@headlessui/vue.svg" alt="Total Downloads"></a>
|
|
<a href="https://github.com/tailwindlabs/headlessui/releases"><img src="https://img.shields.io/npm/v/@headlessui/vue.svg" alt="Latest Release"></a>
|
|
<a href="https://github.com/tailwindlabs/headlessui/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/@headlessui/vue.svg" alt="License"></a>
|
|
</p>
|
|
|
|
## Installation
|
|
|
|
Please note that **this library only supports Vue 3**.
|
|
|
|
```sh
|
|
# npm
|
|
npm install @headlessui/vue
|
|
|
|
# Yarn
|
|
yarn add @headlessui/vue
|
|
```
|
|
|
|
## Components
|
|
|
|
_This project is still in early development. New components will be added regularly over the coming months._
|
|
|
|
- [Menu Button (Dropdown)](./src/components/menu/README.md)
|
|
- [Listbox (Select)](./src/components/listbox/README.md)
|
|
- [Switch (Toggle)](./src/components/switch/README.md)
|
|
- [Disclosure](./src/components/disclosure/README.md)
|
|
- [FocusTrap](./src/components/focus-trap/README.md)
|
|
- [Portal](./src/components/portal/README.md)
|
|
- [Dialog](./src/components/dialog/README.md)
|
|
- [Popover](./src/components/popover/README.md)
|
|
- [Radio Group](./src/components/radio-group/README.md)
|
|
- [Transition](./src/components/transitions/README.md)
|
|
|
|
### Roadmap
|
|
|
|
This project is still in early development, but the plan is to build out all of the primitives we need to provide interactive Vue examples of all of the components included in [Tailwind UI](https://tailwindui.com), the commercial component directory that helps us fund the development of our open-source work like [Tailwind CSS](https://tailwindcss.com).
|
|
|
|
This includes things like:
|
|
|
|
- Tabs
|
|
- Accordions
|
|
|
|
...and more in the future.
|
|
|
|
We'll be continuing to develop new components on an on-going basis, with a goal of reaching a pretty fleshed out v1.0 by the end of the year.
|