Skip to content

A set of accessible custom elements that pairs beautifully with Tailwind CSS.

License

Notifications You must be signed in to change notification settings

abeidahmed/tailwindcss-elements

Repository files navigation

tailwindcss-elements

A set of accessible custom elements that pairs beautifully with Tailwind CSS.

Installation

yarn add tailwindcss-elements

or

npm install tailwindcss-elements

Importing elements

// Imports all the elements
import 'tailwindcss-elements';

// Or, cherry pick what you need
import 'tailwindcss-elements/elements/dialog';
import 'tailwindcss-elements/elements/dropdown';

Custom elements

Styling

Each component exposes the data-headlessui-state attribute that you can use to conditionally apply the classes. You can use the @headlessui/tailwindcss plugin to target this attribute.

Contributing

After cloning the project:

  1. Run yarn install to install the dependencies
  2. Run yarn dev and visit http://localhost:3000 in your browser

Run yarn test to run the tests and yarn test:watch to run it in watch mode.

Bug reports and pull requests are welcome on GitHub at https://github.com/abeidahmed/tailwindcss-elements. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

This project is licensed under the terms of the MIT License.