如何使用文档

How to Read

先按任务找，再查组件和参数

如果还不熟悉 MBJIA Tools，不要从组件分类逐个点开。先确定你要完成的业务任务，再进入对应组件、Props、事件和数据结构。

按场景接入文档地图版本与准确性

推荐路径

第一步：确定任务

先判断你要做的是基础 UI、素材管理、上传、AI 搜索、权益、视频处理，还是工具函数。

第二步：进入场景页

从 按场景接入 找最短阅读路径，避免在分类里反复试错。

第三步：看组件页

组件页优先看适用场景、使用示例、Props、回调、事件协议和注意事项。

第四步：补数据结构

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

常见任务怎么找

任务	搜索词	入口
接一个按钮、弹窗、输入框	Button、Modal、Input	基础 UI
打开素材管理弹窗	素材管理、AssetManagementModal	素材管理弹窗
只做素材选择	AssetModal、素材选择	素材选择弹窗
做全局上传	上传、EveryWhereUpload	全局上传
做 AI 搜索	AI 搜索、AiSearch	AI 搜索
做会员、点数、权益拦截	权益、Payment、VipModal	支付与权益
查接口和返回结构	services、接口名	服务接口
查事件名和 payload	eventBus、事件名	事件协议
不确定装哪个包	包、安装	选择合适的包
查版本差异	版本、alpha、正式包	版本差异

搜索建议

站内搜索适合直接查组件名、包名、功能词和事件名：

类型	示例
组件名	AssetManagementModal、AiSearch、Button
功能词	素材、上传、权益、脚本、分页
包名	@mbjia/ui、@mbjia/components、@mbjia/utils
事件名	global:everywhereUpload、AiSearch:searchTypeChange

如果搜不到，先去 文档地图 看文档入口是否存在；如果文档入口存在但缺 Props、出参或事件说明，按 文档维护 补齐。

阅读组件页时看什么

区块	目的
组件定位	确认这个组件解决什么问题。
适用场景	判断是否应该使用它。
使用示例	复制最小代码，先跑通。
Props / 入参	查必填项、默认值和受控行为。
出参 / 回调	查回调参数和业务状态。
数据结构	查素材、上传、权益等公共类型。
事件协议	查 eventBus 的事件名、方向和触发时机。
前置条件	查登录态、接口权限、worker、环境配置。

版本和准确性

当前站点默认展示当前仓库版本的文档，不是历史版本切换站。业务项目如果使用旧包版本，先看 版本与准确性，确认当前文档是否适用；需要定位版本区间时看 版本差异。