Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add usage with Tailwind documentation #65

Merged
merged 3 commits into from
Jan 18, 2023
Merged

feat: Add usage with Tailwind documentation #65

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
225789e
Add usage with Tailwind documentation
edgarlr Jan 18, 2023
e2a1d09
Update readme.md
edgarlr Jan 18, 2023
ce8c006
Update readme.md
edgarlr Jan 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,27 @@ All browsers that support [`Array.isArray`](https://developer.mozilla.org/en-US/

>**Note:** For IE8 support and older, please install `clsx@1.0.x` and beware of [#17](https://github.com/lukeed/clsx/issues/17).

## Tailwind Support

Here some additional (optional) steps to enable classes autocompletition using `clsx` with Tailwind CSS.
<details>

<summary>
Visual Studio Code
</summary>

1. [Install the "Tailwind CSS IntelliSense" Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)

2. Add the following to your [`settings.json`](https://code.visualstudio.com/docs/getstarted/settings):

```json
{
"tailwindCSS.experimental.classRegex": [
["clsx\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"]
Copy link

@kachkaev kachkaev Jul 17, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 @lukeed! Thanks for adding this regex! Can you please elaborate on your approach to building it? I was using https://github.com/shadcn/ui/blob/5e172fc34fdf015aa0d141f52cc8c082b8ae6613/.vscode/settings.json#L7-L8 before seeing your solution. There is a slight difference, so I'm curious if there are any edge cases not covered by any of the two regexps:

shadcn/ui
- ["cn\\(([^)]*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"]
+ ["cn\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"]
your regex

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@edgarlr contributed this section so perhaps they can offer an explanation.

By eyeballing it, the difference is that ([^']*) will match anything up to ', which means that if " or or backticks appear in the class value, then the regexp in our docs will include it as part of the value, whereas the other regexp stops there.

clsx doc's regexp
Screen Shot 2023-07-18 at 10 43 53 AM

shadcn/ui regexp
Screen Shot 2023-07-18 at 10 44 16 AM

Looks like they're both not ideal, tbh
I don't use this extension, but perhaps something like this is better? I don't know if the extn is looking for the first matching group only, though

Screen Shot 2023-07-18 at 10 53 57 AM

]
}
```
</details>

## Related

Expand Down