An open API service indexing awesome lists of open source software.

https://github.com/chiefpansancolt/stimulus-tailwind-components

StimulusJS for Tailwind Styled Components
https://github.com/chiefpansancolt/stimulus-tailwind-components

npm stimulus-tailwind-components stimulusjs tailwind tailwindcss

Last synced: about 2 months ago
JSON representation

StimulusJS for Tailwind Styled Components

Awesome Lists containing this project

README

        

![Logo](https://github.com/chiefpansancolt/stimulus-tailwind-components/blob/main/.github/stimulus-tailwind-logo.png)

# StimulusJS Tailwind Components

![npm](https://img.shields.io/npm/v/stimulus-tailwind-components?logo=NPM&style=for-the-badge)
![npm](https://img.shields.io/npm/dm/stimulus-tailwind-components?logo=NPM&style=for-the-badge)
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/chiefpansancolt/stimulus-tailwind-components?label=Release&logo=github&style=for-the-badge)
[![Discord](https://img.shields.io/discord/450095227185659905?color=yellow&label=Discord&logo=discord&style=for-the-badge)](https://discord.gg/pBxGpfrmD4)

This package contains pre built stimulus controllers for common [tailwindcss](https://tailwindcss.com) based components inspired by [TailwindUI](https://tailwindui.com) and [HeadlessUI](https://headlessui.com/) to help save you the time from having to build on every project you may need it on.

Currently supports:

- [Notification(s)](https://stimulus-tailwind.chiefpansancolt.dev/docs/features/notification)
- [Theme](https://stimulus-tailwind.chiefpansancolt.dev/docs/features/theme)
- [Switch](https://stimulus-tailwind.chiefpansancolt.dev/docs/features/switch)
- [Modal](https://stimulus-tailwind.chiefpansancolt.dev/docs/features/modal)

## Roadmap

Check out the [roadmap](https://github.com/users/chiefpansancolt/projects/3) to see what other features and/or fixes are coming down the pipeline for this project!

## Installation

Check out our documentation [here](https://stimulus-tailwind.chiefpansancolt.dev/docs/installation) for full details on how to add to your project!

## Examples/Playground

Checkout a live demo of examples [here](https://stimulus-tailwind-play.chiefpansancolt.dev).

## Change Log

Check out the [Change Log](https://stimulus-tailwind.chiefpansancolt.dev/docs/change_log) for new breaking changes/features/bug fixes per release of a new and past versions.

## Contributing

Bug Reports, Feature Requests, and Pull Requests are welcome on GitHub at https://github.com/chiefpansancolt/stimulus-tailwind-components. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://github.com/chiefpansancolt/stimulus-tailwind-components/blob/main/.github/CODE_OF_CONDUCT.md) code of conduct.

To see more about Contributing check out this [document](https://github.com/chiefpansancolt/stimulus-tailwind-components/blob/main/.github/CONTRIBUTING.md).

- Fork Repo and create new branch
- Once all is changed and committed create a pull request.

**Ensure all merge conflicts are fixed and CI is passing.**

## Development

Checkout our development guide [here](https://github.com/chiefpansancolt/stimulus-tailwind-components/blob/main/.github/DEVELOPMENT.md) to see how you can commit to the repo.

_**NOTE: Do not commit any changes made in dist folder from compiling as this will be performed by the owner before building of a release.**_

## License

Stimulus Tailwind Components is available as open source under the terms of the [MIT License](https://github.com/chiefpansancolt/stimulus-tailwind-components/blob/main/LICENSE).

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



Christopher Pezza

💻 📖 🔧 ⚠️ 🚧

This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!