ecklf / tailwindcss-radix

Utilities and variants for styling Radix state
https://tailwindcss-radix.vercel.app
MIT License
2.09k stars 67 forks source link

sparse documentation #37

Closed Johnrobmiller closed 6 months ago

Johnrobmiller commented 1 year ago

I see all those utilities for the animations, but there's no documentation about how to use them. Also, when I go to see the animations in the demo, sometimes there is none (like in the case animating the accordion content height).

Not sure how to proceed without clear documentation.

geoff-harper commented 1 year ago

Some documentation on what this dependency is actually for would be good. Radix explicitly has Tailwind examples for every component and it doesn't appear that they use this. I'd like to know what the purpose is so I can consider if I want/need it

ecklf commented 1 year ago

Radix explicitly has Tailwind examples for every component and it doesn't appear that they use this

Radix didn't have Tailwind examples up until recently.

Some documentation on what this dependency is actually for would be good

The main purpose of this library is that it adds classnames for accessing data attributes. Tailwind added data-* variants after this library came out (which is what the official Radix examples use). However, you don't gain the benefit of auto-completion as it relies on the usage of arbitrary values.

TL;DR it's @headlessui-tailwindcss for Radix