mattpocock / tailwindcss-intellisense Goto Github PK

Tailwind CSS IntelliSense enhances the Tailwind development experience by providing Visual Studio Code users with advanced features such as autocomplete, syntax highlighting, and linting.

Install via the Visual Studio Code Marketplace →

In order for the extension to activate you must have tailwindcss installed and a Tailwind config file named tailwind.config.js in your workspace.

Intelligent suggestions for class names, as well as CSS functions and directives.

Highlights errors and potential bugs in both your CSS and your markup.

See the complete CSS for a Tailwind class name by hovering over it.

Provides syntax definitions so that Tailwind features are highlighted correctly.

VS Code has built-in CSS validation which may display errors when using Tailwind-specific syntax, such as @apply. You can disable this with the css.validate setting:

"css.validate": false

By default VS Code will not trigger completions when editing "string" content, for example within JSX attribute values. Updating the editor.quickSuggestions setting may improve your experience:

"editor.quickSuggestions": {
  "strings": true
}

This setting allows you to add additional language support. The key of each entry is the new language ID and the value is any one of the extensions built-in languages, depending on how you want the new language to be treated (e.g. html, css, or javascript):

{
  "tailwindCSS.includeLanguages": {
    "plaintext": "html"
  }
}

Enable completions when using Emmet-style syntax, for example div.bg-red-500.uppercase. Default: false

Controls whether the editor should render inline color decorators for Tailwind CSS classes and helper functions. Default: true

Note that editor.colorDecorators must be enabled for color decorators to be shown.

Show px equivalents for rem CSS values in completions and hovers. Default: true

Root font size in pixels. Used to convert rem CSS values to their px equivalents. See tailwindCSS.showPixelEquivalents. Default: 16

Enable linting. Rules can be configured individually using the tailwindcss.lint settings:

• ignore: disable lint rule entirely
• warning: rule violations will be considered "warnings," typically represented by a yellow underline
• error: rule violations will be considered "errors," typically represented by a red underline

Unknown screen name used with the @screen directive. Default: error

Unknown variant name used with the @variants directive. Default: error

Unknown value used with the @tailwind directive. Default: error

Unsupported use of the @apply directive. Default: error

Unknown or invalid path used with the theme helper. Default: error

Class names on the same HTML element which apply the same CSS property or properties. Default: warning

Class variants not in the recommended order (applies in JIT mode only). Default: warning

Enable the Node.js inspector agent for the language server and listen on the specified port. Default: null

If you’re having issues getting the IntelliSense features to activate, there are a few things you can check:

• Ensure that you have a Tailwind config file in your workspace and that this is named tailwind.config.js. Check out the Tailwind documentation for details on creating a config file.
• Ensure that the tailwindcss module is installed in your workspace, via npm, yarn, or pnpm.
• Make sure your VS Code settings aren’t causing your Tailwind config file to be hidden/ignored, for example via the files.exclude or files.watcherExclude settings.
• Take a look at the language server output by running the Tailwind CSS: Show Output command from the command palette. This may show errors that are preventing the extension from activating.