---
name: brick
description: Brick 组件库使用指引。通过 `/brick:<component>` 查阅组件文档（Props、典型用法、注意事项），`/brick:guide` 查阅跨组件选型指引，`/brick:theme` 查阅主题变量。适用于所有使用 @befe/brick 的项目。
---

# Brick 组件查阅 Skill

## 使用时机

当用户在使用 `@befe/brick` 组件库的项目中，需要查阅组件用法、Props、选型建议时触发。

## 命令

### `/brick:<component>`

查阅指定组件的文档。例如：

- `/brick:button` — 查阅 Button 组件文档
- `/brick:table` — 查阅 Table 组件文档
- `/brick:dialog` — 查阅 Dialog 组件文档

**行为**：读取本 skill 同级 `docs/<component>.md` 文件，将内容作为上下文提供给用户。

### `/brick:guide`

查阅跨组件选型指引（Button vs Link、Select vs Suggest、Dialog vs Drawer 等）。

**行为**：读取 `docs/_guide.md`。

### `/brick:theme`

查阅主题变量和 mixins 列表。

**行为**：读取 `docs/_theme.md`。

### `/brick`（无参数）

列出所有可用组件及一句话简介。

**行为**：读取 `docs/_index.md` 中的组件列表部分。

## 文件定位

本 skill 的文档文件位于相对路径 `../docs/`（即 `packages/main/docs/`）。

消费项目安装方式：

```bash
# 方式 1：符号链接（推荐）
ln -s ./node_modules/@befe/brick/skill .agents/skills/brick

# 方式 2：直接复制
cp -r ./node_modules/@befe/brick/skill .agents/skills/brick
```

## 路由逻辑

收到 `/brick:<arg>` 时：

1. 若 `<arg>` 为 `guide` → 读取 `docs/_guide.md`
2. 若 `<arg>` 为 `theme` → 读取 `docs/_theme.md`
3. 否则视为组件名 → 读取 `docs/<arg>.md`
4. 若文件不存在 → 提示用户该组件文档暂未生成，建议查看 `_index.md` 确认组件名

## 注意事项

- 文档内容为中文
- Props 表中的类型和默认值来自源码解析，可信赖
- 典型用法代码片段可直接参考，但需根据实际场景调整
- 若文档版本与实际安装版本不一致，以源码为准