---
version: 0.2.203
---

# Brick 组件文档

> 本文档供 Agent 按需查阅，通过 `/brick:[component]` 指令读取具体组件文档。

## 通用文档

- [guide](_guide.md) — 跨组件选型指引，帮助判断相似组件间的选择。
- [theme](_theme.md) — 主题变量与 mixins 参考，包含所有 SCSS 变量和可用 mixin。
- [icon-svg](_icon-svg.md) — `@befe/brick-icon` 暴露的全部 `SvgXxx` 目录，按分组列出，含已废弃图标的替代映射。

## 组件列表

- [alert](alert.md) — 页面内的提示通知组件，用于展示信息、成功、警告、错误等状态反馈。
- [badge](badge.md) — 徽标组件，用于在元素右上角展示数字、文字标记或状态圆点。
- [breadcrumb](breadcrumb.md) — 面包屑导航组件，用于展示当前页面在层级结构中的位置。
- [button](button.md) — 按钮组件，用于触发操作或导航。支持多种类型、颜色、尺寸，以及 loading 状态和异步操作。
- [cascade](cascade.md) — 级联选择组件，用于从多层级数据中逐级选择。支持单选、多选、懒加载等模式。
- [checkbox](checkbox.md) — 复选框组件，用于在一组选项中进行多项选择。支持单独使用和分组使用。
- [clear-x](clear-x.md) — 控件的「清除」按钮，基于 Button 封装，点击后清空控件当前值。与 CloseX（关闭 / 移除）语义区分。
- [close-x](close-x.md) — 关闭按钮组件，用于关闭弹窗、面板等容器。基于 Button 封装，支持异步操作和 loading 状态。
- [code](code.md) — 代码高亮展示组件，基于 react-syntax-highlighter 的 Prism 实现。
- [collapse](collapse.md) — 折叠面板组件，用于将内容分组折叠展示。支持手风琴模式和多面板同时展开。
- [config-provider](config-provider.md) — 全局配置提供者组件，为子孙组件提供 i18n、主题、响应判断等全局配置。
- [date-picker](date-picker.md) — 日期选择器组件，支持日期、月份、季度选择，以及日期范围选择和多日期选择。
- [dialog](dialog.md) — 模态对话框组件，用于需要用户确认或填写信息的场景。支持声明式 `<Dialog>` 和命令式 `confirm()` / `alert()` 两种调用方式。
- [download](download.md) — 下载按钮组件，通过 iframe 方式触发文件下载，支持下载前拦截和下载状态提示。
- [drawer](drawer.md) — 抽屉组件，从屏幕边缘滑出的浮层面板。支持四个方向、遮罩配置和操作按钮。
- [drop-menu](drop-menu.md) — 下拉菜单组件，点击或悬停触发的菜单列表。支持单选、多选、分组和多级菜单。
- [file-list](file-list.md) — 文件列表组件，用于展示文件集合，支持预览、下载、删除、重试等操作，以及上传进度和错误状态。
- [form](form.md) — 表单组件，基于 react-final-form 封装，提供表单状态管理和符合规范的 Field 结构与样式。Form 是 uncontrolled 型组件，通过 render props 提供操作 API。
- [grid](grid.md) — 栅格布局组件，基于 Bootstrap Grid System 实现，提供 Container、Row、Col 三级结构，支持流式布局和响应式布局。
- [head-nav](head-nav.md) — 顶部导航栏组件，提供 logo、菜单、用户信息等标准顶栏结构。支持深色/浅色主题和多级菜单。
- [icon](icon.md) — 图标组件，用于渲染 SVG 图标。支持自定义颜色、旋转动画和点击交互。
- [input](input.md) — 输入框组件，支持多种输入类型、前后缀、清除按钮和状态展示。
- [intro](intro.md) — 产品导览组件，用于以幻灯片形式引导用户了解产品功能或新特性。
- [layout](layout.md) — 布局容器组件，基于 flex 布局实现页面整体结构。
- [link](link.md) — 链接组件，用于页面间或外部跳转的文字链接。
- [loading](loading.md) — 加载状态组件，用于在数据加载或异步操作时提供视觉反馈。
- [lottie](lottie.md) — Lottie 动画播放组件，基于 lottie-web 实现。
- [markdown](markdown.md) — Markdown 渲染组件，基于 react-markdown 实现，支持插件扩展和自定义渲染器。
- [menu](menu.md) — 导航菜单组件，支持垂直/水平布局、多级子菜单、分组、弹出菜单等模式。
- [message](message.md) — 全局消息提示，用于操作后的轻量反馈。以函数式调用，从页面顶部弹出，自动消失。
- [modal](modal.md) — 模态弹层基础组件，提供带遮罩的模态弹层行为，可用来拓展为 Dialog、模态提示等。
- [notification](notification.md) — 通知提醒组件，以函数式调用在页面角落弹出通知消息，支持多种类型和位置。
- [num-input](num-input.md) — 数字输入框组件，支持步进、精度控制、范围限制、千分分隔符等功能。
- [page](page.md) — 页面布局组件，提供标准的页头、侧边栏、面包屑、内容区、页脚的页面结构。
- [pagination](pagination.md) — 分页组件，支持普通分页、简单分页、纯数字分页等多种类型。
- [popover](popover.md) — 气泡框组件，承载聚合类信息。包含 Popover（信息气泡）和 PopoverConfirm（确认气泡）两个子组件。
- [popper](popper.md) — 基础弹层定位组件，基于 Popper.js v2 实现。作为底层组件为 Popover、Tooltip、MenuPopper 等提供定位能力。
- [popup](popup.md) — 基础弹出组件，提供 Portal 能力，将子节点渲染到 DOM 树的指定位置。作为底层组件可扩展为弹窗 Modal、弹层 Popper、Toast 容器等。
- [poster](poster.md) — 张贴画组件，用于展示页面级状态信息，如 404、403、空状态、成功、维护中等。
- [preview](preview.md) — 图片预览组件，支持单图/多图预览、异步加载、缩放等功能。通过命令式 API 调用。
- [radio](radio.md) — 单选框组件，支持单独使用和分组使用，提供多种类型和尺寸。
- [rich-text](rich-text.md) — 基于 Lexical 的轻量富文本编辑器，支持块类型、缩进、对齐、字号、图片等功能。
- [section](section.md) — 内容分区组件，用于页面中对内容进行分组并提供标题标识。
- [select](select.md) — 下拉选择组件，支持单选和多选模式，支持分组选项。
- [side-nav](side-nav.md) — 侧边导航组件，用于页面侧边栏的多级菜单导航。支持折叠、展开和反色模式。
- [steps](steps.md) — 步骤条组件，用于展示流程进度和当前所处步骤。
- [suggest](suggest.md) — 搜索建议组件，支持异步搜索选项并选择。提供单选（Suggest）和多选（MultiSuggest）两种模式。
- [switch](switch.md) — 开关组件，用于切换两种状态（开/关）。支持 loading 状态和异步变更前确认。
- [table](table.md) — 表格组件，用于展示结构化数据。支持固定列、固定表头、排序、合并单元格、树状数据等功能。
- [tabs](tabs.md) — 标签页组件，用于在同一区域内切换不同内容面板。支持多种样式类型和动态增删。
- [tag](tag.md) — 标签组件，用于标记和分类。支持普通展示、可选择和可编辑三种模式。
- [textarea](textarea.md) — 多行文本输入组件，支持字数统计和高度自适应。
- [time-picker](time-picker.md) — 时间选择器组件，支持时分和时分秒两种模式。
- [toast](toast.md) — 轻量级消息提示组件，用于全局反馈操作结果。通过函数式调用触发。
- [tooltip](tooltip.md) — 文字提示气泡框组件，用于鼠标悬浮时显示简单文案解释。
- [tour](tour.md) — 新手引导组件，用于分步骤引导用户了解页面功能。支持高亮目标元素和自定义步骤内容。
- [tree](tree.md) — 树形控件，用于展示层级结构数据。支持展开/收起、选中和 checkbox 多选。
- [upload](upload.md) — 文件上传组件，支持单文件/多文件上传、拖拽上传、文件列表管理。

## Manifest

记录各组件最后生成时对应的包版本，供增量更新使用。

| 组件 | 包版本 |
|------|--------|
| alert | 0.2.112 |
| badge | 0.2.108 |
| breadcrumb | 0.2.112 |
| button | 0.2.111 |
| cascade | 0.2.136 |
| checkbox | 0.2.109 |
| clear-x | 0.2.0-rc |
| close-x | 0.2.112 |
| code | 0.2.108 |
| collapse | 0.2.110 |
| config-provider | 0.2.107 |
| date-picker | 0.2.125 |
| dialog | 0.2.120 |
| download | 0.2.115 |
| drawer | 0.2.122 |
| drop-menu | 0.2.127 |
| file-list | 0.2.120 |
| form | 0.2.123 |
| grid | 0.2.108 |
| head-nav | 0.2.127 |
| icon | 0.2.108 |
| input | 0.2.115 |
| intro | 0.2.56 |
| layout | 0.2.108 |
| link | 0.2.108 |
| loading | 0.2.109 |
| lottie | 0.2.108 |
| markdown | 0.2.109 |
| menu | 0.2.126 |
| message | 0.2.113 |
| modal | 0.2.109 |
| notification | 0.2.113 |
| num-input | 0.2.119 |
| page | 0.2.131 |
| pagination | 0.2.133 |
| popover | 0.2.119 |
| popper | 0.2.112 |
| popup | 0.2.108 |
| poster | 0.2.109 |
| preview | 0.2.46 |
| radio | 0.2.109 |
| rich-text | 0.2.69 |
| section | 0.2.109 |
| select | 0.2.131 |
| side-nav | 0.2.127 |
| steps | 0.2.53 |
| suggest | 0.2.136 |
| switch | 0.2.108 |
| table | 0.2.138 |
| tabs | 0.2.126 |
| tag | 0.2.115 |
| textarea | 0.2.111 |
| time-picker | 0.2.120 |
| toast | 0.2.113 |
| tooltip | 0.2.112 |
| tour | 0.2.63 |
| tree | 0.2.56 |
| upload | 0.2.123 |