Components.json

    Configuration for your project.

    The components.json file holds configuration for your project.

    We use it to understand how your project is set up and how to generate components customized for your project.

    Note: The components.json file is optional and only required if you're using the CLI to add components to your project. If you're using the copy and paste method, you don't need this file.

    You can create a components.json file in your project by running the following command:

     
    npx revueui@latest init

    See the CLI section for more information.

    $schema

    You can see the JSON Schema for components.json here.

    {
  "$schema": "https://ui.bastiencouder.com/schema.json"
}

    tailwind

    Configuration to help the CLI understand how Tailwind CSS is set up in your project.

    See the installation section for how to set up Tailwind CSS.

    tailwind.config

    Path to where your tailwind.config.js file is located.

    {
  "tailwind": {
    "config": "tailwind.config.js" | "tailwind.config.ts"
  }
}

    tailwind.css

    Path to the CSS file that imports Tailwind CSS into your project.

    {
  "tailwind": {
    "css": "styles/global.css"
  }
}

    tailwind.cssVariables

    You can choose between using CSS variables or Tailwind CSS utility classes for theming.

    To use utility classes for theming set tailwind.cssVariables to false. For CSS variables, set tailwind.cssVariables to true.

    {
  "tailwind": {
    "cssVariables": true | false
  }
}

    For more information, see the theming docs.

    This cannot be changed after initialization. To switch between CSS variables and utility classes, you'll have to delete and re-install your components.

    framework

    This option is automatically set by the CLI based on the framework you're using.

    {
  "framework": "react"
}

    aliases

    The CLI uses these values and the paths config from your tsconfig.json or jsconfig.json file to place generated components in the correct location.

    Path aliases have to be set up in your tsconfig.json or jsconfig.json file.

    Important: If you're using the src directory, make sure it is included under paths in your tsconfig.json or jsconfig.json file.

    aliases.utils

    Import alias for your utility functions.

    {
  "aliases": {
    "utils": "@/lib/utils"
  }
}

    aliases.components

    Import alias for your components.

    {
  "aliases": {
    "components": "@/components"
  }
}

    aliases.ui

    Import alias for ui components.

    The CLI will use the aliases.ui value to determine where to place your ui components. Use this config if you want to customize the installation directory for your ui components.

    {
  "aliases": {
    "ui": "@/app/ui"
  }
}

    aliases.lib

    Import alias for lib functions such as format-date or generate-id.

    {
  "aliases": {
    "lib": "@/lib"
  }
}

    aliases.hooks

    Import alias for hooks such as use-media-query or use-toast.

    {
  "aliases": {
    "hooks": "@/hooks"
  }
}