Skip to content

Latest commit

 

History

History
137 lines (90 loc) · 3.35 KB

README.md

File metadata and controls

137 lines (90 loc) · 3.35 KB
Raw

VSCode Twind Intellisense (Phoenix)

English | 简体中文

20240816-233530.mp4

About It

This is a VSCode extension that provides intelligent insights for Twind.

Why does the name end with Phoenix? Because it is rising from the ashes, and one day, it will shine as brightly as it once did.

Features

  • Intelligent suggestions
  • Clear class information
  • Color previews

How to Use

After installing the extension, simply configure it as follows.

{
  // [Important] Specify the presets used in the project, such as `tailwind`, ...
  "twind-intellisense.presets": ["tailwind", "typography"]
  // ... see below for additional configurations
}

Configuration

twind-intellisense.enabled

  • Description: Enable the extension

  • Type: boolean

  • Default: true

twind-intellisense.presets

  • Description: Presets used in the project

  • Type: Array<'tailwind' | '[email protected]' | 'tailwind-forms' | 'autoprefix' | 'container-queries' | 'line-clamp' | 'radix-ui' | 'typography'>

  • Default: ["tailwind"]

  • Additional Notes:

    If your project uses the tailwind preset, be sure to add it.

    [email protected] corresponds to @phoenix-twind/preset-tailwind, supports the latest [email protected].

    tailwind corresponds to @twind/preset-tailwind, and the others follow similarly.

twind-intellisense.configPath

  • Description: Path to the Twind configuration file

  • Type: string | undefined

  • Additional Notes:

    This should be specified relative to the workspace root.

    1. You can specify the full path to the configuration file, e.g., 'path/to/twind.config.js'
    2. You can specify the directory containing the configuration file, e.g., 'path/to/' (it will automatically look for twind.config.js or twind.config.ts in that directory)
    3. If not specified, it will default to looking for 'twind.config.(js|ts)' in the workspace root directory

    Additionally, even on Windows systems, always use forward slashes (/) as path separators

twind-intellisense.colorPreview

  • Description: Color preview configuration

  • Type: object

  • Properties:

    • enabled:
      • Description: Whether to enable the color preview feature
      • Type: boolean
      • Default: true

  • Example:

    {
  "twind-intellisense.colorPreview": {
    "enabled": true
  }
}

twind-intellisense.classExtraction

  • Description: Configuration for class extraction

  • Type: object

  • Properties:

    • prefixes:
      • Description: The prefixes of classes to extract, as regex strings. For example: "class(Name)?="
      • Type: Array<string>
    • ignorePrefixes:
      • Description: The prefixes of classes to ignore, as regex strings. For example: "css(?=`|\()"
      • Type: Array<string>

  • Example:

    {
  "twind-intellisense.classExtraction": {
    "prefixes": ["class(Name)?="],
    "ignorePrefixes": ["css(?=`|()"]
  }
}

Language Support Status

  • HTML
  • JavaScript
  • JavaScriptReact
  • TypeScript
  • TypeScriptReact
  • Vue
  • Svelte
  • SolidJS
  • ...

CHANGELOG

CHANGELOG.md

License

MIT License © 2024-PRESENT xlboy