Tiu

Tiu

Get Tailwind Intellisense anywhere

Get Tailwind Intellisense anywhere

Subscribe to my newsletter and never miss my upcoming articles

Links:


Tailwind intellisense is amazing.

But, sometimes I use libraries that use props other than class/classNames.

For example HeadlessUI's Transition component: Pasted image 20210715110235.png

Or the clsx library: Pasted image 20210715110238.png

So how do we get intellisense here?

First go to your open your workspace settings.

cmd_palette.png

This will create a settings.json file under a .vscode folder if you don't already have one. You can define rules within it. The one we're interested about is tailwindCSS.experimental.classRegex.

In this we define an array of arrays containing regex to match a pattern.

For example using the clsx library:

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

Let's review what happened there.

The first item in the array is an expression to the container, and the second expression is to match the class lists.

Container_Classlists.png

NOTE: Both expressions must contain only one capture group.


If you only have a single class list like the HeadlessUI example, you can specify a single regular expression.

{
  "tailwindCSS.experimental.classRegex": [
    "(?:enter|leave)(?:From|To)?=\\s*(?:\"|')([^(?:\"|')]*)"
  ]
}

You can also use multiple expressions for different contexts

{
  "tailwindCSS.experimental.classRegex": [
    ["clsx\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"],
    "(?:enter|leave)(?:From|To)?=\\s*(?:\"|')([^(?:\"|')]*)"
  ]
}

I know, regex is hard, so heres a repo containing multiple use cases. github.com/paolotiu/tailwind-regex-list

I encourage you to contribute if there are any other use cases that haven't been listed. Thank you :)

Proudly part of