# Twistail React

[![npm version](https://img.shields.io/npm/v/twistail-react)](https://www.npmjs.com/package/twistail-react)
[![npm downloads](https://img.shields.io/npm/dm/twistail-react)](https://www.npmjs.com/package/twistail-react)
[![license-apache](https://img.shields.io/badge/License-Apache_2.0-blue.svg)][license-apache]
[![license-mit](https://img.shields.io/badge/License-MIT-blue.svg)][license-mit]

Twistail is an Open Source React UI component library that leverages [Tailwind CSS][tailwindcss]
and [Tailwind Variants][tailwind-variants] for a powerful variant API. It enables advanced
component composition and responsive variants while managing style conflicts efficiently.
Built on [Radix UI Primitives][radix-ui] and implemented with [TypeScript][typescript],
Twistail provides a suite of UI elements, including charts and data visualization components.

Perfect for developers seeking a **customizable design** system that prioritizes accessibility
and performance, Twistail streamlines implementation with a **copy-paste** approach and
deep customization options.

Visit the [documentation][twistail-docs] page for more detailed information.

**Compatibility**: ESM-only.

## Installation

```sh
# Install with npm
npm install twistail-react

# Install with pnpm
pnpm add twistail-react

# Install with yarn
yarn add twistail-react
```

## License

Licensed under either of [Apache License 2.0][license-apache] or [MIT license][license-mit] at your option.
To understand the key differences between these two popular open-source licenses, please refer to the
[Apache License 2.0][tldr-apache] and the [MIT License][tldr-mit] on tldrlegal.com.

Copyrights in this project are retained by their contributors.

See the [LICENSE-APACHE][license-apache] and [LICENSE-MIT][license-mit] files for more information.

[contributors]: https://github.com/riipandi/twistail/network/dependencies
[license-apache]: https://github.com/riipandi/twistail/blob/main/LICENSE-APACHE
[license-mit]: https://github.com/riipandi/twistail/blob/main/LICENSE-MIT
[radix-ui]: https://www.radix-ui.com/primitives
[tailwind-variants]: https://www.tailwind-variants.org
[tailwindcss]: https://tailwindcss.com
[tldr-apache]: https://www.tldrlegal.com/license/apache-license-2-0-apache-2-0
[tldr-mit]: https://www.tldrlegal.com/license/mit-license
[twistail-docs]: https://twistail.com/docs
[typescript]: https://www.typescriptlang.org