文档地图

Documentation Map

参数、返回值、数据结构和示例在哪里看？

指南页只负责帮你开始使用。真正接入时，需要按下面的入口查看组件示例、Props、事件、数据结构、接口返回值和限制说明。

按场景接入基础组件业务组件数据结构服务接口

你想查什么

目标	去哪里看	内容
不知道该从哪里开始	按场景接入	按真实任务给出阅读顺序和最小路径
使用示例和效果预览	基础 UI / 业务组件	组件效果、基础用法、典型业务用法
组件入参	具体组件页的 Props	字段、类型、是否必填、默认值、说明
组件事件	具体组件页的 事件协议 或 事件协议	事件名、方向、触发时机、payload
接口入参和出参	服务接口	请求函数、参数、返回值、响应结构
公共数据结构	公共数据结构	素材、目录、分页、上传凭证、搜索参数
上传数据格式	上传数据	上传任务、OSS 参数、进度回调、返回结构
Hooks 入参和返回值	Hooks 总览 以及各分类页	Hook 参数、返回字段、示例
包能力边界	包总览	每个包负责什么、适合什么场景

组件文档入口

基础 UI

ButtonModalInputDropDownPopupBreadCrumbBreadCrumbLevelsPaginationUploadSolidArrowSelectHeadlessBaseBtn

业务组件

素材管理弹窗素材选择弹窗全局上传AI 搜索支付与权益媒体流程展示组件

API 与类型入口

公共数据结构

素材模型、目录模型、素材搜索参数、创建素材参数、OSS 凭证结构。

服务接口

接口统一响应、常用服务方法、请求参数和返回结构。

事件协议

跨组件通信事件、触发方向、业务说明。

上传数据

上传任务结构、OSS 上传参数、进度回调和上传结果。

推荐查阅顺序

先看示例

从基础组件或业务组件页复制最小示例，确认页面能跑起来。

再看 Props

确认必填字段、默认值、回调函数和受控/非受控行为。

最后看数据结构和事件

涉及素材、上传、AI、权益时，再查公共数据结构、接口返回值和事件协议。

如果某个组件页暂时只有总览，没有完整 Props 或出参表，说明该页还需要补齐。维护者应按“效果预览、使用示例、Props、Events、Data、限制”的模板补充。