shadcn-vue

shadcn-vue

一个用于构建 UI、组件和设计系统的框架。组件通过 CLI 以源代码形式添加到用户项目中。

重要： 所有 CLI 命令请使用项目的包管理器运行：npx shadcn-vue@latest、pnpm dlx shadcn-vue@latest 或 bunx --bun shadcn-vue@latest——根据项目的 packageManager 选择。以下示例使用 npx shadcn-vue@latest，但请根据项目替换为正确的运行器。

当前项目上下文

!`npx shadcn-vue@latest info --json`

上述 JSON 包含项目配置和已安装的组件。使用 npx shadcn-vue@latest docs <component> 获取任何组件的文档和示例 URL。

原则

1. 优先使用现有组件。 在编写自定义 UI 之前，使用 npx shadcn-vue@latest search 检查注册表。同时检查社区注册表。
2. 组合，而非重新发明。 设置页面 = Tabs + Card + 表单控件。仪表盘 = Sidebar + Card + Chart + Table。
3. 优先使用内置变体，而非自定义样式。 如 variant="outline"、size="sm" 等。
4. 使用语义化颜色。 如 bg-primary、text-muted-foreground——绝不要使用原始值如 bg-blue-500。

关键规则

以下规则始终强制执行。每条规则链接到一个包含错误/正确代码对的文件。

样式与 Tailwind → styling.md

• class 用于布局，而非样式。 绝不要覆盖组件的颜色或排版。
• 不要使用 space-x-* 或 space-y-*。 使用 flex 配合 gap-*。对于垂直堆叠，使用 flex flex-col gap-*。
• 当宽度和高度相等时使用 size-*。 使用 size-10 而非 w-10 h-10。
• 使用 truncate 简写。 而非 overflow-hidden text-ellipsis whitespace-nowrap。
• 不要手动覆盖 dark: 颜色。 使用语义化 token（如 bg-background、text-muted-foreground）。
• 使用 cn() 处理条件类。 不要手动编写模板字面量三元表达式。
• 不要在覆盖层组件上手动设置 z-index。 Dialog、Sheet、Popover 等组件自行处理层级。

表单与输入 → forms.md

• 表单使用 FieldGroup + Field。 绝不要使用原始 div 配合 space-y-* 或 grid gap-* 进行表单布局。
• InputGroup 使用 InputGroupInput/InputGroupTextarea。 绝不要在 InputGroup 内部使用原始 Input/Textarea。
• 输入框内的按钮使用 InputGroup + InputGroupAddon。
• 选项集（2–7 个选项）使用 ToggleGroup。 不要循环 Button 并手动管理激活状态。
• 使用 FieldSet + FieldLegend 对相关复选框/单选按钮进行分组。 不要使用带标题的 div。
• 字段验证使用 data-invalid + aria-invalid。 data-invalid 放在 Field 上，aria-invalid 放在控件上。对于禁用状态：data-disabled 放在 Field 上，disabled 放在控件上。

组件结构 → composition.md

• 项目始终放在其 Group 内。 SelectItem → SelectGroup。DropdownMenuItem → DropdownMenuGroup。CommandItem → CommandGroup。
• Dialog、Sheet 和 Drawer 始终需要标题。 为了无障碍性，必须包含 DialogTitle、SheetTitle、DrawerTitle。如果视觉上隐藏，使用 class="sr-only"。
• 使用完整的 Card 组合。 CardHeader/CardTitle/CardDescription/CardContent/CardFooter。不要将所有内容都放在 CardContent 中。
• Button 没有 isPending/isLoading。 使用 Spinner + data-icon + disabled 组合。
• TabsTrigger 必须放在 TabsList 内部。 绝不要直接在 Tabs 中渲染触发器。
• Avatar 始终需要 AvatarFallback。 用于图片加载失败的情况。

使用组件，而非自定义标记 → composition.md

• 在编写自定义标记之前优先使用现有组件。 在编写样式化 div 之前检查组件是否存在。
• 提示使用 Alert。 不要构建自定义样式 div。
• 空状态使用 Empty。 不要构建自定义空状态标记。
• Toast 使用 vue-sonner。 使用 vue-sonner 的 toast() 函数。
• 使用 Separator 替代 <hr> 或 <div class="border-t">。
• 使用 Skeleton 作为加载占位符。不要使用自定义 animate-pulse div。
• 使用 Badge 替代自定义样式 span。

图标 → icons.md

• Button 中的图标使用 data-icon。 在图标上使用 data-icon="inline-start" 或 data-icon="inline-end"。
• 组件内部的图标不要使用尺寸类。 组件通过 CSS 处理图标尺寸。不要使用 size-4 或 w-4 h-4。
• 将图标作为对象传递，而非字符串键。 使用 :icon="CheckIcon"，而非字符串查找。

CLI

• 直接使用 CLI 应用预设代码。 对于现有项目使用 npx shadcn-vue@latest apply <code>，初始化时使用 npx shadcn-vue@latest init --preset <code>。

关键模式

以下是区分正确 shadcn-vue 代码的最常见模式。对于边界情况，请参阅上面链接的规则文件。

<!-- 表单布局：FieldGroup + Field，而非 div + Label。 -->
<FieldGroup>
  <Field>
    <FieldLabel for="email">邮箱</FieldLabel>
    <Input id="email" />
  </Field>
</FieldGroup>

<!-- 验证：data-invalid 在 Field 上，aria-invalid 在控件上。 -->
<Field data-invalid>
  <FieldLabel>邮箱</FieldLabel>
  <Input aria-invalid />
  <FieldDescription>无效的邮箱。</FieldDescription>
</Field>

<!-- 按钮中的图标：data-icon，无尺寸类。 -->
<Button>
  <SearchIcon data-icon="inline-start" />
  搜索
</Button>

<!-- 间距：gap-*，而非 space-y-*。 -->
<div class="flex flex-col gap-4">  <!-- 正确 -->
<div class="space-y-4">           <!-- 错误 -->

<!-- 等宽高：size-*，而非 w-* h-*。 -->
<Avatar class="size-10">   <!-- 正确 -->
<Avatar class="w-10 h-10"> <!-- 错误 -->

<!-- 状态颜色：Badge 变体或语义化 token，而非原始颜色。 -->
<Badge variant="secondary">+20.1%</Badge>    <!-- 正确 -->
<span class="text-emerald-600">+20.1%</span> <!-- 错误 -->

组件选择

需求	使用
按钮/操作	Button 配合适当的 variant
表单输入	Input、Select、Combobox、Switch、Checkbox、RadioGroup、Textarea、InputOTP、Slider
在 2–7 个选项间切换	ToggleGroup + ToggleGroupItem
数据展示	Table、Card、Badge、Avatar
导航	Sidebar、NavigationMenu、Breadcrumb、Tabs、Pagination
覆盖层	Dialog（模态框）、Sheet（侧面板）、Drawer（底部面板）、AlertDialog（确认框）
反馈	vue-sonner（toast）、Alert、Progress、Skeleton、Spinner
命令面板	Command 放在 Dialog 内部
图表	Chart（封装 Unovis）
布局	Card、Separator、Resizable、ScrollArea、Accordion、Collapsible
空状态	Empty
菜单	DropdownMenu、ContextMenu、Menubar
工具提示/信息	Tooltip、HoverCard、Popover

关键字段

注入的项目上下文包含以下关键字段：

• aliases → 使用实际的别名前缀进行导入（例如 @/、~/），绝不要硬编码。
• tailwindVersion → "v4" 使用 @theme inline 块；"v3" 使用 tailwind.config.js。
• tailwindCssFile → 定义自定义 CSS 变量的全局 CSS 文件。始终编辑此文件，绝不要创建新文件。
• style → 组件视觉处理（例如 nova、vega）。
• base → 基础库（reka）。影响组件 API 和可用属性。
• iconLibrary → 决定图标导入。lucide 使用 @lucide/vue，tabler 使用 @tabler/icons-vue 等。绝不要假设为 @lucide/vue。
• resolvedPaths → 组件、工具函数、hooks 等的确切文件系统路径。
• framework → 路由和文件约定（例如 Nuxt 与 Vite SPA）。
• packageManager → 用于安装非 shadcn-vue 依赖（例如 pnpm add date-fns 与 npm install date-fns）。

参见 cli.md — info 命令 获取完整字段参考。

组件文档、示例和使用

运行 npx shadcn-vue@latest docs <component> 获取组件文档、示例和 API 参考的 URL。获取这些 URL 以获取实际内容。

npx shadcn-vue@latest docs button dialog select

在创建、修复、调试或使用组件时，始终先运行 npx shadcn-vue@latest docs 并获取 URL。 这确保您使用正确的 API 和使用模式，而非猜测。

工作流程

1. 获取项目上下文 — 已在上方注入。如果需要刷新，再次运行 npx shadcn-vue@latest info。
2. 首先检查已安装的组件 — 在运行 add 之前，始终检查项目上下文中的 components 列表或列出 resolvedPaths.ui 目录。不要导入尚未添加的组件，也不要重复添加已安装的组件。
3. 查找组件 — npx shadcn-vue@latest search。
4. 获取文档和示例 — 运行 npx shadcn-vue@latest docs <component> 获取 URL，然后获取它们。使用 npx shadcn-vue@latest view 浏览尚未安装的注册表项。要预览对已安装组件的更改，使用 npx shadcn-vue@latest add --diff。
5. 安装或更新 — npx shadcn-vue@latest add。更新现有组件时，先使用 --dry-run 和 --diff 预览更改（参见下面的更新组件）。
6. 修复第三方组件中的导入 — 从社区注册表添加组件后，检查添加的非 UI 文件中是否有硬编码的导入路径如 @/components/ui/...。这些可能与项目的实际别名不匹配。使用 npx shadcn-vue@latest info 获取正确的 ui 别名（例如 @workspace/ui/components）并重写导入。CLI 会重写其自身 UI 文件的导入，但第三方注册表组件可能使用与项目不匹配的默认路径。
7. 审查添加的组件 — 从任何注册表添加组件或块后，始终读取添加的文件并验证其正确性。检查缺少的子组件（例如没有 SelectGroup 的 SelectItem）、缺少的导入、不正确的组合或违反关键规则的情况。同时将任何图标导入替换为项目上下文中的 iconLibrary（例如，如果注册表项使用 @lucide/vue 但项目使用 hugeicons，则相应交换导入和图标名称）。在继续之前修复所有问题。
8. 注册表必须明确 — 当用户要求添加块或组件时，不要猜测注册表。如果未指定注册表（例如用户说“添加一个登录块”而未指定 @shadcn 等），询问使用哪个注册表。绝不要代表用户默认选择注册表。
9. 切换预设 — 首先询问用户：覆盖、合并还是跳过？
   • 覆盖：npx shadcn-vue@latest apply <code>。覆盖检测到的组件、字体和 CSS 变量。
   • 合并：npx shadcn-vue@latest init --preset <code> --force --no-reinstall，然后运行 npx shadcn-vue@latest info 列出已安装的组件，然后对每个已安装的组件使用 --dry-run 和 --diff 进行智能合并。
   • 跳过：npx shadcn-vue@latest init --preset <code> --force --no-reinstall。仅更新配置和 CSS，保持组件不变。
   • 重要：始终在用户的项目目录内运行预设命令。apply 仅适用于已有 components.json 文件的现有项目。CLI 会自动保留 components.json 中的当前基础（reka）。如果必须使用临时目录（例如用于 --dry-run 比较），请显式传递 --base <current-base>——预设代码不编码基础。

更新组件

当用户要求从上游更新组件同时保留本地更改时，使用 --dry-run 和 --diff 进行智能合并。绝不要手动从 GitHub 获取原始文件——始终使用 CLI。

1. 运行 npx shadcn-vue@latest add <component> --dry-run 查看所有受影响的文件。
2. 对于每个文件，运行 npx shadcn-vue@latest add <component> --diff <file> 查看上游与本地之间的更改。
3. 根据差异决定每个文件的操作：
   • 无本地更改 → 可以安全覆盖。
   • 有本地更改 → 读取本地文件，分析差异，并在保留本地修改的同时应用上游更新。
   • 用户说“直接更新所有内容” → 使用 --overwrite，但先确认。
4. 未经用户明确同意，绝不要使用 --overwrite。

快速参考

# 创建新项目。
npx shadcn-vue@latest init --name my-app --preset nova
npx shadcn-vue@latest init --name my-app --preset a2r6bw --template vite

# 初始化现有项目。
npx shadcn-vue@latest init --preset nova
npx shadcn-vue@latest init --defaults  # 快捷方式：--template=nuxt --preset=nova（基础样式隐含）

# 对现有项目应用预设。
npx shadcn-vue@latest apply a2r6bw

# 添加组件。
npx shadcn-vue@latest add button card dialog
npx shadcn-vue@latest add --all

# 搜索注册表。
npx shadcn-vue@latest search @shadcn -q "sidebar"

# 获取组件文档和示例 URL。
npx shadcn-vue@latest docs button dialog select

# 查看注册表项详情（针对尚未安装的项）。
npx shadcn-vue@latest view @shadcn/button

命名预设： nova、vega、maia、lyra、mira、luma
模板： nuxt、vite、astro 和 laravel
预设代码： 版本前缀的 base62 字符串（例如 a2r6bw），来自 shadcn-vue.com。

详细参考

• rules/forms.md — FieldGroup、Field、InputGroup、ToggleGroup、FieldSet、验证状态
• rules/composition.md — Groups、覆盖层、Card、Tabs、Avatar、Alert、Empty、Toast、Separator、Skeleton、Badge、Button 加载
• rules/icons.md — data-icon、图标尺寸、将图标作为对象传递
• rules/styling.md — 语义化颜色、变体、class、间距、尺寸、truncate、暗色模式、cn()、z-index
• cli.md — 命令、标志、预设、模板
• customization.md — 主题、CSS 变量、扩展组件