components.json

组件.json

**描述：**您的项目配置。

**用途：**我们使用它来了解您的项目设置方式以及如何生成针对您的项目定制的组件。

您可以通过运行以下命令在项目中创建 components.json 文件：

npx shadcn-ui@latest init

有关详细信息，请参见 CLI 部分。

$schema

您可以在 这里 看到 components.json 的 JSON Schema。

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

style

您的组件样式。初始化后不能更改。

{
  "style": "default" | "new-york"
}

tailwind

配置以帮助 CLI 了解项目中 Tailwind CSS 的设置方式。

有关如何设置 Tailwind CSS 的信息，请参见 安装部分。

tailwind.config

您的 tailwind.config.js 文件所在的路径。

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

tailwind.css

导入 Tailwind CSS 到项目的 CSS 文件的路径。

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

tailwind.baseColor

这用于为您的组件生成默认调色板。初始化后不能更改。

{
  "tailwind": {
    "baseColor": "gray" | "neutral" | "slate" | "stone" | "zinc"
  }
}

tailwind.cssVariables

您可以在主题化中选择使用 CSS 变量或 Tailwind CSS 实用程序类。

要将实用程序类用于主题化，请将 tailwind.cssVariables 设置为 false。对于 CSS 变量，将 tailwind.cssVariables 设置为 true。

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

有关详细信息，请参见 主题化文档。

**初始化后不能更改。**要在 CSS 变量和实用程序类之间切换，您必须删除并重新安装组件。

tailwind.prefix

用于 Tailwind CSS 实用程序类的前缀。组件将添加此前缀。

{
  "tailwind": {
    "prefix": "tw-"
  }
}

rsc

是否启用对 React 服务器组件的支持。

当设置为 true 时，CLI 会自动将 use client 指令添加到客户端组件。

{
  "rsc": `true` | `false`
}

tsx

在 TypeScript 或 JavaScript 组件之间选择。

将此选项设置为 false 允许将组件作为带 .jsx 文件扩展名的 JavaScript 添加。

{
  "tsx": `true` | `false`
}

aliases

CLI 使用这些值和 tsconfig.json 或 jsconfig.json 文件中的 paths 配置将生成的组件放置在正确的位置。

路径别名必须在 tsconfig.json 或 jsconfig.json 文件中设置。

aliases.utils

实用程序函数的导入别名。

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

aliases.components

组件的导入别名。

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

aliases.ui

ui 组件的导入别名。

CLI 将使用 aliases.ui 值来确定将 ui 组件放置在何处。如果您想定制 ui 组件的安装目录，请使用此配置。

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