@fjyueke/arco-mcp 1.0.0 → 1.0.1

package/metaData/components/date-picker/api.md

@@ -0,0 +1,94 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|onOk|点击选中时执行的回调|(timestamp: number \| \[number, number\], obj: IDateObj \| \[IDateObj, IDateObj\]) =\> void|-|
+|currentTs|当前选中的时间，timestamp|number \| \[number, number\]|Date.now()|
+|onChange|选中后的回调|(timestamp: number \| \[number, number\], obj: IDateObj \| \[IDateObj, IDateObj\]) =\> void|-|
+|onValueChange|每列数据选择变化后的回调函数|(timestamp: number, obj: IDateObj, index: number) =\> void|-|
+|mode|可选列类型，date \- 年月日，time \- 时分秒，datetime \- 年月日时分秒|"date" \| "time" \| "datetime"|"datetime"|
+|typeArr|可选列数组|ItemType\[\]|[]|
+|minTs|最小可选日期，timestamp|number \| \{ startTs: number; endTs: number; \}|当前时间的前十年|
+|maxTs|最大可选日期，timestamp|number \| \{ startTs: number; endTs: number; \}|当前时间的后十年|
+|useUTC|是否使用 UTC 时间|boolean|false|
+|rangeItemFormat|日期时间范围选择展示格式|string|-|
+|formatter|各可选项展示的格式化方法，参数type为ItemTypes，参数value为当前行的值，返回展示的文字|(value: number, type: ItemType) =\> string|(value: number) => (value < 10 ? \`0${value}\` : String(value))|
+|valueFilter|可选择行过滤方法，参数type为ItemType，参数value为当前行的值，返回true表示该行可选择|(type: ItemType, value: number) =\> boolean|() => true|
+|columnsProcessor|选择器列表项干预，可插入自定义选项|(columns: PickerData\[\]\[\], currentDateObj: IDateObj) =\> PickerData\[\]\[\]|-|
+|renderSeparator|自定义分隔符|() =\> ReactNode|-|
+|renderLinkedContainer|将选择器的展现隐藏状态及选中值的展示与某个容器关联，传入后将同时渲染该容器和选择器组件，此时选择器组件的 visible 和 onHide 属性可不传，点击该容器会唤起选择器|(currentTs: number \| \[number, number\], itemTypes: ItemType\[\]) =\> ReactNode|-|
+|visible|是否展示选择器|boolean|false|
+|maskClosable|点击蒙层是否关闭菜单|boolean|false|
+|needBottomOffset|从底部滑出的菜单内容是否适配ipx底部|boolean|false|
+|translateZ|\[即将废弃\] 开启translateZ强制提升|boolean|false|
+|maskTransitionTimeout|菜单蒙层动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|{ enter: 450, exit: 240 }|
+|contentTransitionTimeout|菜单内容动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|{ enter: 450, exit: 240 }|
+|contentTransitionType|内容过渡动画类名|string|\`slide-from-${props.direction}\`|
+|className|自定义类名|string|-|
+|maskClass|自定义蒙层类名|string|-|
+|maskStyle|自定义蒙层样式|CSSProperties|-|
+|contentClass|自定义内容类名|string|-|
+|contentStyle|自定义内容样式|CSSProperties|-|
+|maskTransitionType|蒙层过渡动画类名|string|"fade"|
+|contentTransitionVarType|内容过渡动画类名变量标识|string|-|
+|animatingClosable|执行进场动画时点击蒙层是否可关闭菜单|boolean|false|
+|mountOnEnter|是否在打开菜单时再加载内容|boolean|true|
+|unmountOnExit|是否在退出时卸载内容|boolean|true|
+|preventBodyScroll|弹窗打开时是否禁止body的滚动|boolean|true|
+|initialBodyOverflow|页面初始 overflow 状态，即关闭弹窗时 overflow 应该还原的状态|string|第一个全屏组件（弹窗、toast等）打开时页面overflow值|
+|gestureOutOfControl|是否禁用滚动容器手势判断，禁用后交给业务方自己判断|boolean|true|
+|onClose|关闭后回调（动画执行完毕）|(scene?: string) =\> void|-|
+|onOpen|打开后回调（动画执行完毕）|() =\> void|-|
+|onMaskClick|点击蒙层回调，maskClosable=false时也会触发|() =\> void|-|
+|onTouchMove|弹窗的touchmove回调|(e: TouchEvent, prevented: boolean, direction: "x" \| "y") =\> void|-|
+|onPreventTouchMove|非滚动区域或滚动到顶部及底部时的触摸事件回调|(e: TouchEvent, direction: "x" \| "y") =\> void|-|
+|getContainer|获取挂载容器|() =\> HTMLElement|-|
+|rows|行数(一列可选项的行数)，必须是奇数，最小为3个|number|5|
+|disabled|是否不可用|boolean|false|
+|onHide|点击遮罩层或取消、确定按钮的隐藏回调|(scene?: string) =\> void|-|
+|itemStyle|每列样式|CSSProperties|-|
+|okText|弹窗确认已选值的文案|string|"确定"|
+|dismissText|弹窗取消的文案|string|"取消"|
+|onDismiss|点击取消时执行的回调|() =\> void|-|
+|clickable|是否可通过点击操作选择内容|boolean|true|
+|hideEmptyCols|是否隐藏无数据的空列，常用于级联选择|boolean|false|
+|title|选择器标题|string|""|
+|touchToStop|是否通过长按停止滑动，传入数字 x 表示触摸超过 x 毫秒算长按，传 true 表示 x=100，长按事件与 click 事件互斥|number \| boolean|false|
+|renderExtraHeader|自定义头部扩展区域|() =\> ReactNode|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+
+> IDateObj
+
+|参数|描述|类型|
+|----------|-------------|------|
+|year|年|number|
+|month|月|number|
+|date|日|number|
+|hour|时|number|
+|minute|分|number|
+|second|秒|number|
+
+> mode
+
+```
+"date" | "time" | "datetime"
+```
+
+> ItemType
+
+```
+"date" | "year" | "month" | "hour" | "minute" | "second"
+```
+
+> PickerData
+
+|参数|描述|类型|
+|----------|-------------|------|
+|value|每一列展示的每项文案对应的值|ReactText|
+|label|每一列展示的文案|ReactNode|
+|children|级联状态下，该列对应的下一列数据|PickerData\[\]|

package/metaData/components/dialog/api.md

@@ -0,0 +1,192 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|title|弹窗标题|ReactNode|-|
+|footer|底部按钮配置|FooterButtonOptions\[\]|[]|
+|footerType|底部按钮样式，grid表示通栏样式，button表示按钮样式，platform=ios时有效|"grid" \| "button"|"grid"|
+|renderFooter|自定义渲染footer|() =\> ReactNode|-|
+|footerCollapseCount|底部按钮大于等于多少个时竖向排布|number|3|
+|titleAlign|标题对齐方向|"left" \| "center" \| "right"|platform=android 时为"left"，否则为"center"|
+|contentAlign|内容对齐方向|"left" \| "center" \| "right"|platform=android 时为"left"，否则为"center"|
+|platform|当前所在操作系统，对应不同样式|"ios" \| "android"|跟随当前所在系统|
+|extra|弹窗中的其他元素，比如关闭按钮等|ReactNode|-|
+|contentTransitionType|内容过渡动画类名|string|platform=android 时为"fade"，否则为"fade-scale"|
+|maskTransitionTimeout|蒙层动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|300|
+|contentTransitionTimeout|弹窗内容动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|450|
+|className|自定义类名|string|-|
+|maskClass|自定义蒙层类名|string|-|
+|maskStyle|自定义蒙层样式|CSSProperties|-|
+|contentClass|自定义内容类名|string|-|
+|contentStyle|自定义内容样式|CSSProperties|-|
+|visible|是否展示菜单（受控）|boolean|必填|
+|close|关闭菜单方法|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> void|必填|
+|maskTransitionType|蒙层过渡动画类名|string|"fade"|
+|contentTransitionVarType|内容过渡动画类名变量标识|string|-|
+|children|菜单内部内容|ReactNode|-|
+|maskClosable|点击蒙层是否关闭菜单|boolean|true|
+|animatingClosable|执行进场动画时点击蒙层是否可关闭菜单|boolean|false|
+|mountOnEnter|是否在打开菜单时再加载内容|boolean|true|
+|unmountOnExit|是否在退出时卸载内容|boolean|true|
+|orientationDirection|transform方向，用于通过transform模拟横屏的情况|"left" \| "right" \| "top" \| "bottom"|"top"|
+|preventBodyScroll|弹窗打开时是否禁止body的滚动|boolean|true|
+|initialBodyOverflow|页面初始 overflow 状态，即关闭弹窗时 overflow 应该还原的状态|string|第一个全屏组件（弹窗、toast等）打开时页面overflow值|
+|gestureOutOfControl|是否禁用滚动容器手势判断，禁用后交给业务方自己判断|boolean|false|
+|onClose|关闭后回调（动画执行完毕）|(scene?: string) =\> void|-|
+|onOpen|打开后回调（动画执行完毕）|() =\> void|-|
+|onMaskClick|点击蒙层回调，maskClosable=false时也会触发|() =\> void|-|
+|onTouchMove|弹窗的touchmove回调|(e: TouchEvent, prevented: boolean, direction: "x" \| "y") =\> void|-|
+|onPreventTouchMove|非滚动区域或滚动到顶部及底部时的触摸事件回调|(e: TouchEvent, direction: "x" \| "y") =\> void|-|
+|getContainer|获取挂载容器|() =\> HTMLElement|-|
+|getScrollContainer|内容内部滚动区域容器，在该容器中未滚动到顶部或底部时会释放滚动|() =\> HTMLElement \| HTMLElement\[\]|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|mask|蒙层 DOM|HTMLDivElement|
+|content|内容 DOM|HTMLDivElement|
+|setCloseScene|在关闭弹窗前修改 onClose 的 scene 参数值|(scene: string) =\> void|
+
+> 方法/Methods
+
+|方法名|描述|类型|
+|----------|-------------|------|
+|alert|打开确认框(含一个确认按钮)|(config: AlertOptions & DialogProps) =\> \{ close: () =\> void; update: (newConfig: AlertOptions & DialogProps) =\> void; \}|
+|confirm|打开提示框(含一个确认按钮和一个取消按钮)|(config: ConfirmOptions & AlertOptions) =\> \{ close: () =\> void; update: (newConfig: ConfirmOptions & AlertOptions) =\> void; \}|
+|open|打开常规对话框|(config: DialogProps) =\> \{ close: () =\> void; update: (newConfig: DialogProps) =\> void; \}|
+
+> FooterButtonOptions
+
+|参数|描述|类型|
+|----------|-------------|------|
+|content|按钮内容|ReactNode \| ((locale: ILocale) =\> ReactNode)|
+|className|按钮类名|string|
+|disabled|是否禁用按钮|boolean|
+|onClick|点击按钮事件，返回值为true时可以阻止dialog关闭|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> boolean \| void \| Promise\<boolean \| void\>|
+
+> ILocale
+
+|参数|描述|类型|
+|----------|-------------|------|
+|locale|语言类型|string|
+|LoadMore|-|\{ loadMoreText: string; loadingText: string; noDataText: string; failLoadText: string; prepareScrollText: string; prepareClickText: string; \}|
+|Picker|-|\{ okText: string; cancelText: string; \}|
+|Tag|-|\{ addTag: string; \}|
+|Dialog|-|\{ okText: string; cancelText: string; \}|
+|SwipeLoad|-|\{ normalText: string; activeText: string; \}|
+|PullRefresh|-|\{ loadingText: string; pullingText: string; finishText: string; loosingText: string; \}|
+|DropdownMenu|-|\{ select: string; \}|
+|Pagination|-|\{ previousPage: string; nextPage: string; \}|
+|Image|-|\{ loadError: string; \}|
+|ImagePicker|-|\{ loadError: string; \}|
+|SearchBar|-|\{ placeholder: string; cancelBtn: string; \}|
+|Stepper|-|\{ minusButtonName: string; addButtonName: string; \}|
+|Keyboard|-|\{ confirm: string; \}|
+|Form|-|\{ required: string; type: \{ email: string; url: string; string: string; number: string; array: string; object: string; boolean: string; \}; number: \{ min: string; max: string; equal: string; range: string; positive: string; negative: string; \}; \.\.\. 4 more \.\.\.; pickerDefaultHint: string; \}|
+|NavBar|-|\{ backBtnAriaLabel: string; \}|
+|Uploader|-|\{ uploadBtn: string; retryUpload: string; \}|
+
+> AlertOptions
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|key|组件挂载容器id区分|string|-|
+|onOk|点击确认按钮回调|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> boolean \| void \| Promise\<boolean \| void\>|-|
+|okText|确认按钮文字|ReactNode|-|
+|unmountOnExit|是否在退出时卸载内容|boolean|true|
+|getContainer|获取挂载容器|() =\> HTMLElement|-|
+|onClose|关闭后回调（动画执行完毕）|(scene?: string) =\> void|-|
+|title|弹窗标题|ReactNode|-|
+|footer|底部按钮配置|FooterButtonOptions\[\]|[]|
+|footerType|底部按钮样式，grid表示通栏样式，button表示按钮样式，platform=ios时有效|"grid" \| "button"|"grid"|
+|renderFooter|自定义渲染footer|() =\> ReactNode|-|
+|footerCollapseCount|底部按钮大于等于多少个时竖向排布|number|3|
+|titleAlign|标题对齐方向|"left" \| "center" \| "right"|platform=android 时为"left"，否则为"center"|
+|contentAlign|内容对齐方向|"left" \| "center" \| "right"|platform=android 时为"left"，否则为"center"|
+|platform|当前所在操作系统，对应不同样式|"ios" \| "android"|跟随当前所在系统|
+|extra|弹窗中的其他元素，比如关闭按钮等|ReactNode|-|
+|contentTransitionType|内容过渡动画类名|string|platform=android 时为"fade"，否则为"fade-scale"|
+|maskTransitionTimeout|蒙层动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|300|
+|contentTransitionTimeout|弹窗内容动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|450|
+|className|自定义类名|string|-|
+|maskClass|自定义蒙层类名|string|-|
+|maskStyle|自定义蒙层样式|CSSProperties|-|
+|contentClass|自定义内容类名|string|-|
+|contentStyle|自定义内容样式|CSSProperties|-|
+|maskTransitionType|蒙层过渡动画类名|string|"fade"|
+|contentTransitionVarType|内容过渡动画类名变量标识|string|-|
+|children|菜单内部内容|ReactNode|-|
+|maskClosable|点击蒙层是否关闭菜单|boolean|true|
+|animatingClosable|执行进场动画时点击蒙层是否可关闭菜单|boolean|false|
+|mountOnEnter|是否在打开菜单时再加载内容|boolean|true|
+|orientationDirection|transform方向，用于通过transform模拟横屏的情况|"left" \| "right" \| "top" \| "bottom"|"top"|
+|preventBodyScroll|弹窗打开时是否禁止body的滚动|boolean|true|
+|initialBodyOverflow|页面初始 overflow 状态，即关闭弹窗时 overflow 应该还原的状态|string|第一个全屏组件（弹窗、toast等）打开时页面overflow值|
+|gestureOutOfControl|是否禁用滚动容器手势判断，禁用后交给业务方自己判断|boolean|false|
+|onOpen|打开后回调（动画执行完毕）|() =\> void|-|
+|onMaskClick|点击蒙层回调，maskClosable=false时也会触发|() =\> void|-|
+|onTouchMove|弹窗的touchmove回调|(e: TouchEvent, prevented: boolean, direction: "x" \| "y") =\> void|-|
+|onPreventTouchMove|非滚动区域或滚动到顶部及底部时的触摸事件回调|(e: TouchEvent, direction: "x" \| "y") =\> void|-|
+|getScrollContainer|内容内部滚动区域容器，在该容器中未滚动到顶部或底部时会释放滚动|() =\> HTMLElement \| HTMLElement\[\]|-|
+
+> GlobalContextParams
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|prefixCls|组件类名前缀|string|"arco"|
+|system|手动控制当前所在系统，传入后将直接使用传入的值，ssr场景需指定系统初始值时适用|"" \| "ios" \| "android" \| "pc"|""|
+|useDarkMode|是否监听系统原生的暗黑模式变化(prefers\-color\-scheme: dark)以判断是否切为暗黑模式|boolean|false|
+|isDarkMode|是否处于暗黑模式，指定后以指定的值为准|boolean|false|
+|darkModeSelector|当处于暗黑模式时，body上挂载的类名，为空值时不挂载类名|string|"arco-theme-dark"|
+|theme|主题变量，传入后将在线替换css变量，需设置less变量 @use\-css\-vars: 1|Record\<string, string\>|-|
+|locale|国际化语言包配置|ILocale|-|
+|useRtl|是否使用Rtl模式|boolean|false|
+|onDarkModeChange|当系统原生暗黑模式发生变化时触发，useDarkMode=true 时有效|(isDark: boolean) =\> void|-|
+|createRoot|React19 修改了 createRoot 的引入路径，导致组件内部无法直接引入（低react版本会找不到模块）。因此使用 react 19 的用户需从外部传入 createRoot 方法|CreateRootFnType|-|
+
+> ConfirmOptions
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|onCancel|点击取消按钮回调|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> boolean \| void \| Promise\<boolean \| void\>|-|
+|cancelText|取消按钮文字|ReactNode|-|
+|key|组件挂载容器id区分|string|-|
+|onOk|点击确认按钮回调|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> boolean \| void \| Promise\<boolean \| void\>|-|
+|okText|确认按钮文字|ReactNode|-|
+|unmountOnExit|是否在退出时卸载内容|boolean|true|
+|getContainer|获取挂载容器|() =\> HTMLElement|-|
+|onClose|关闭后回调（动画执行完毕）|(scene?: string) =\> void|-|
+|title|弹窗标题|ReactNode|-|
+|footer|底部按钮配置|FooterButtonOptions\[\]|[]|
+|footerType|底部按钮样式，grid表示通栏样式，button表示按钮样式，platform=ios时有效|"grid" \| "button"|"grid"|
+|renderFooter|自定义渲染footer|() =\> ReactNode|-|
+|footerCollapseCount|底部按钮大于等于多少个时竖向排布|number|3|
+|titleAlign|标题对齐方向|"left" \| "center" \| "right"|platform=android 时为"left"，否则为"center"|
+|contentAlign|内容对齐方向|"left" \| "center" \| "right"|platform=android 时为"left"，否则为"center"|
+|platform|当前所在操作系统，对应不同样式|"ios" \| "android"|跟随当前所在系统|
+|extra|弹窗中的其他元素，比如关闭按钮等|ReactNode|-|
+|contentTransitionType|内容过渡动画类名|string|platform=android 时为"fade"，否则为"fade-scale"|
+|maskTransitionTimeout|蒙层动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|300|
+|contentTransitionTimeout|弹窗内容动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|450|
+|className|自定义类名|string|-|
+|maskClass|自定义蒙层类名|string|-|
+|maskStyle|自定义蒙层样式|CSSProperties|-|
+|contentClass|自定义内容类名|string|-|
+|contentStyle|自定义内容样式|CSSProperties|-|
+|maskTransitionType|蒙层过渡动画类名|string|"fade"|
+|contentTransitionVarType|内容过渡动画类名变量标识|string|-|
+|children|菜单内部内容|ReactNode|-|
+|maskClosable|点击蒙层是否关闭菜单|boolean|true|
+|animatingClosable|执行进场动画时点击蒙层是否可关闭菜单|boolean|false|
+|mountOnEnter|是否在打开菜单时再加载内容|boolean|true|
+|orientationDirection|transform方向，用于通过transform模拟横屏的情况|"left" \| "right" \| "top" \| "bottom"|"top"|
+|preventBodyScroll|弹窗打开时是否禁止body的滚动|boolean|true|
+|initialBodyOverflow|页面初始 overflow 状态，即关闭弹窗时 overflow 应该还原的状态|string|第一个全屏组件（弹窗、toast等）打开时页面overflow值|
+|gestureOutOfControl|是否禁用滚动容器手势判断，禁用后交给业务方自己判断|boolean|false|
+|onOpen|打开后回调（动画执行完毕）|() =\> void|-|
+|onMaskClick|点击蒙层回调，maskClosable=false时也会触发|() =\> void|-|
+|onTouchMove|弹窗的touchmove回调|(e: TouchEvent, prevented: boolean, direction: "x" \| "y") =\> void|-|
+|onPreventTouchMove|非滚动区域或滚动到顶部及底部时的触摸事件回调|(e: TouchEvent, direction: "x" \| "y") =\> void|-|
+|getScrollContainer|内容内部滚动区域容器，在该容器中未滚动到顶部或底部时会释放滚动|() =\> HTMLElement \| HTMLElement\[\]|-|

package/metaData/components/divider/api.md

@@ -0,0 +1,17 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|hairline|是否使用 0\.5px 线|boolean|true|
+|content|文字|ReactNode|-|
+|align|文字位置|"left" \| "center" \| "right"|'center'|
+|width|分割线宽度（单边），仅在\`align\`为\`center\`时生效|ReactText|-|
+|children|子元素，同 content，优先级低于 content|ReactNode|null|
+|className|自定义类名|string|""|
+|style|自定义样式|CSSProperties|{}|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层 DOM 元素|HTMLDivElement|

package/metaData/components/dropdown/api.md

@@ -0,0 +1,72 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|showDropdown|是否展开下拉框|boolean|必填|
+|options|展示的选项,优先级低于dropdownNode|OptionsItem\[\]|[]|
+|children|自定义下拉框元素|ReactNode|-|
+|onCancel|取消选择|() =\> void|必填|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|extraNode|下拉框底部元素|ReactNode|-|
+|top|定位下拉框出现的位置|number|-|
+|bottom|向上展开时下拉框出现的位置|number|-|
+|direction|展开方向|"up" \| "down"|"down"|
+|height|受控模式，下拉框高度|number|-|
+|maxHeight|下拉框最大的高度|number|500|
+|clickOtherToClose|点击其他区域是否取消选择|boolean|true|
+|touchToClose|是否在触发touchstart时就取消选择，否则在click之后再取消选择|boolean|true|
+|dropdownAnimationTimeout|展开收起动画的时间|number|300|
+|dropdownAnimationFunction|展开收起动画曲线函数|string|"cubic-bezier(0.32, 0.96, 0.6, 1)"|
+|showMask|是否展示遮罩层|boolean|true|
+|maskAnimationTimeout|蒙层动画时长|number|500|
+|maskAnimationFunction|蒙层动画函数|string|"cubic-bezier(0.32, 0.96, 0.6, 1)"|
+|useColumn|使用多列标签样式，传 true 为 4 列，传数字为指定 n 列|number \| boolean|false|
+|optionIcon|选项附带图标|ReactNode|-|
+|mountOnEnter|是否在打开下拉框时再加载内容|boolean|true|
+|unmountOnExit|是否在退出时卸载内容|boolean|true|
+|preventBodyScroll|弹窗打开时是否禁止body的滚动|boolean|true|
+|initialBodyOverflow|页面初始 overflow 状态，即关闭弹窗时 overflow 应该还原的状态|string|第一个全屏组件（弹窗、toast等）打开时页面overflow值|
+|getAnchorElement|用于定位的元素，优先级低于top/bottom|() =\> HTMLElement|当前DOM所在位置的父元素|
+|isStopTouchEl|点击某元素时是否阻止关闭面板, 优先级高于\`getStopTouchElement\`，当 clickOtherToClose=true 时有效|(el: HTMLElement) =\> boolean|-|
+|getStopTouchElements|可阻止关闭面板的元素，当 clickOtherToClose=true 时有效|() =\> HTMLElement\[\]|当前组件的父元素|
+|getScrollContainer|内容内部滚动区域容器，在该容器中未滚动到顶部或底部时会释放滚动|() =\> HTMLElement \| HTMLElement\[\]|-|
+|getPortalContainer|获取挂载容器|() =\> HTMLElement|-|
+|multiple|是否支持多选|boolean|false|
+|defaultSelectedValue|默认选中值|string \| number \| ReactText\[\]|-|
+|selectedValue|当前选择的选项标识|string \| number \| ReactText\[\]|-|
+|onOptionClick|点击选项时触发的回调函数|((val: ReactText, op: OptionsItem) =\> void) \| ((selected: boolean, val: ReactText, op: OptionsItem) =\> void)|-|
+|onOptionChange|当选项改变时触发的回调函数|((val: ReactText, op: OptionsItem) =\> void) \| ((vals: ReactText\[\], op: OptionsItem) =\> void)|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+
+> Dropdown.Options
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|options|展示的选项列表|OptionsItem\[\]|必填|
+|useColumn|使用多列标签样式，传 true 为 4 列，传数字为指定 n 列|number \| boolean|false|
+|icon|选项列表右侧图标|ReactNode|-|
+|multiple|是否支持多选|boolean|false|
+|defaultSelectedValue|默认选中值|string \| number \| ReactText\[\]|-|
+|selectedValue|当前选择的选项标识|string \| number \| ReactText\[\]|-|
+|onOptionClick|点击选项时触发的回调函数|((val: ReactText, op: OptionsItem) =\> void) \| ((selected: boolean, val: ReactText, op: OptionsItem) =\> void)|-|
+|onOptionChange|当选项改变时触发的回调函数|((val: ReactText, op: OptionsItem) =\> void) \| ((vals: ReactText\[\], op: OptionsItem) =\> void)|-|
+
+> OptionsItem
+
+|参数|描述|类型|
+|----------|-------------|------|
+|label|选项名称|ReactNode|
+|value|选项标识|ReactText|
+|disabled|选项是否可用，默认false表示可用|boolean|
+
+> DropdownOptionsRef
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|

package/metaData/components/dropdown-menu/api.md

@@ -0,0 +1,83 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|defaultSelectIndex|初始被选择的选择器的序号|number|-|
+|selectIndex|(受控) 被选择的选择器的序号|number|-|
+|disabled|选择器禁用状态|boolean\[\]|-|
+|selectTips|选择器的说明|string\[\]|-|
+|onSelectChange|当选中的选择器改变的时候触发的回调函数|(selectIndex: number) =\> void|-|
+|icon|选择器右侧的图标|ReactNode|-|
+|defaultShowDropdown|初始状态,下拉框状态|boolean|-|
+|showDropdown|可选受控，组件挂载时下拉框的状态|boolean|-|
+|onDropdownChange|下拉框展示状态改变时触发的回调函数|(dropdown: boolean, selectIndex?: number) =\> void|-|
+|getContainer|获得下拉框的容器|() =\> HTMLDivElement|-|
+|chooseAndClose|选择后是否收起面板，仅单选有效|boolean|true|
+|onCancel|取消选择|() =\> void|-|
+|children|自定义下拉框元素|ReactNode|-|
+|extraForDropdown|dropdown参数|DropdownCommonProps|-|
+|multiple|是否支持多选|boolean|false|
+|options|下拉框展示的选择项，其中级联选项仅单选支持|string\[\] \| OptionsItem\[\]\[\] \| CascadeOptions\[\]|必填|
+|defaultValues|初始选择项|ReactText\[\] \| ReactText\[\]\[\]|-|
+|values|(受控) 每个选择器选中的项|ReactText\[\] \| ReactText\[\]\[\]|-|
+|renderSelectLabel|自定义选择器|((op: OptionsItem, index: number) =\> ReactNode) \| ((op: OptionsItem\[\], index: number) =\> ReactNode)|-|
+|onOptionClick|点击选项时触发的回调函数|((value: ReactText, item: OptionsItem, selectIndex?: number) =\> void) \| ((selected: boolean, val: ReactText, item: OptionsItem, selectIndex?: number) =\> void)|-|
+|onOptionChange|选项改变时触发的回调函数|((value: ReactText, item: OptionsItem, selectIndex?: number) =\> void) \| ((vals: ReactText\[\], item: OptionsItem, selectIndex?: number) =\> void)|-|
+|onValuesChange|所有选择器选项总值改变时的回调函数|((values: ReactText\[\]) =\> void) \| ((values: ReactText\[\]\[\]) =\> void)|-|
+|getFormattedOptions|格式化传入的options|((options: string\[\] \| OptionsItem\[\]\[\] \| CascadeOptions\[\], values?: ReactText\[\]) =\> \{ formattedOptions: OptionsItem\[\]\[\]; formattedValue: ReactText\[\]; \}) \| ((options: string\[\] \| \.\.\. 1 more \.\.\. \| CascadeOptions\[\], values?: ReactText\[\]\[\]) =\> \{ \.\.\.; \})|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+
+> DropdownCommonProps
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|extraNode|下拉框底部元素|ReactNode|-|
+|top|定位下拉框出现的位置|number|-|
+|bottom|向上展开时下拉框出现的位置|number|-|
+|direction|展开方向|"up" \| "down"|"down"|
+|height|受控模式，下拉框高度|number|-|
+|maxHeight|下拉框最大的高度|number|500|
+|clickOtherToClose|点击其他区域是否取消选择|boolean|true|
+|touchToClose|是否在触发touchstart时就取消选择，否则在click之后再取消选择|boolean|true|
+|dropdownAnimationTimeout|展开收起动画的时间|number|300|
+|dropdownAnimationFunction|展开收起动画曲线函数|string|"cubic-bezier(0.32, 0.96, 0.6, 1)"|
+|showMask|是否展示遮罩层|boolean|true|
+|maskAnimationTimeout|蒙层动画时长|number|500|
+|maskAnimationFunction|蒙层动画函数|string|"cubic-bezier(0.32, 0.96, 0.6, 1)"|
+|useColumn|使用多列标签样式，传 true 为 4 列，传数字为指定 n 列|number \| boolean|false|
+|optionIcon|选项附带图标|ReactNode|-|
+|mountOnEnter|是否在打开下拉框时再加载内容|boolean|true|
+|unmountOnExit|是否在退出时卸载内容|boolean|true|
+|preventBodyScroll|弹窗打开时是否禁止body的滚动|boolean|true|
+|initialBodyOverflow|页面初始 overflow 状态，即关闭弹窗时 overflow 应该还原的状态|string|第一个全屏组件（弹窗、toast等）打开时页面overflow值|
+|getAnchorElement|用于定位的元素，优先级低于top/bottom|() =\> HTMLElement|当前DOM所在位置的父元素|
+|isStopTouchEl|点击某元素时是否阻止关闭面板, 优先级高于\`getStopTouchElement\`，当 clickOtherToClose=true 时有效|(el: HTMLElement) =\> boolean|-|
+|getStopTouchElements|可阻止关闭面板的元素，当 clickOtherToClose=true 时有效|() =\> HTMLElement\[\]|当前组件的父元素|
+|getScrollContainer|内容内部滚动区域容器，在该容器中未滚动到顶部或底部时会释放滚动|() =\> HTMLElement \| HTMLElement\[\]|-|
+|getPortalContainer|获取挂载容器|() =\> HTMLElement|-|
+
+> OptionsItem
+
+|参数|描述|类型|
+|----------|-------------|------|
+|label|选项名称|ReactNode|
+|value|选项标识|ReactText|
+|disabled|选项是否可用，默认false表示可用|boolean|
+
+> CascadeOptions
+
+|参数|描述|类型|
+|----------|-------------|------|
+|children|级联选择的下一级内容|OptionsItem\[\]|
+|label|选项名称|ReactNode|
+|value|选项标识|ReactText|
+|disabled|选项是否可用，默认false表示可用|boolean|

package/metaData/components/ellipsis/api.md

@@ -0,0 +1,25 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|maxHeight|最大显示高度，单位 px，优先级高于 maxLine|number|-|
+|endExcludes|文本结尾处（缩略符之前）需要过滤掉的字符|string\[\]|[]|
+|reflowOnResize|容器大小变化时是否自适应，使用原生缩略时默认为 true|boolean|false|
+|floatEllipsisNode|文本缩略时，缩略符节点是否浮在文本右下角（默认加渐变色背景）|boolean|false|
+|onReflow|文本缩略处理的完成回调|(ellipsis: boolean, text: string) =\> void|-|
+|text|需要缩略的文本内容|string|必填|
+|ellipsis|是否开启缩略|boolean|true|
+|maxLine|最大显示行数|number|1|
+|dangerouslyUseInnerHTML|是否使用 innerHTML 插入文本（警告：务必确保 text 安全可靠，否则易导致 XSS 漏洞）|boolean|false|
+|ellipsisNode|自定义缩略符节点，文本缩略时插入文本尾部|ReactNode|"..."|
+|collapseNode|自定义收起符节点，不为空且文本展开时插入文本尾部|ReactNode|-|
+|onEllipsisNodeClick|缩略节点点击事件|(e: MouseEvent\<HTMLSpanElement, MouseEvent\>) =\> void|-|
+|onCollapseNodeClick|收起节点点击事件|(e: MouseEvent\<HTMLSpanElement, MouseEvent\>) =\> void|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|reflow|控制容器重新编排|() =\> void|

package/metaData/components/form/api.md

@@ -0,0 +1,82 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|layout|表单项布局|"horizontal" \| "vertical" \| "inline"|"horizontal"|
+|form|表单实例|IFormInstance|-|
+|initialValues|表单初始数据|Record\<string, any\>|-|
+|onValuesChange|表单项数据变化时的回调|(changedValues: any, values: any) =\> void|-|
+|onChange|表单项数据变化时的回调（仅用户操作表单时触发）|(changedValues: any, values: any) =\> void|-|
+|onSubmit|表单项数据变化时的回调|(values: any, otherInfo?: IFieldError\[\]) =\> void|-|
+|onSubmitFailed|表单项数据变化时的回调|(values: any, errorInfo: IFieldError\[\] \| Error) =\> void|-|
+|disabled|表单禁止输入|boolean|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLFormElement|
+|form|Form对象实例|IFormInstance|
+
+> Form.Item
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|label|表单项名|ReactNode|必填|
+|style|表单项Stylesheet|CSSProperties|-|
+|className|表单项样式|string|-|
+|field|表单项字段|string|必填|
+|required|表单项是否必填|boolean|-|
+|disabled|表单项是否禁用|boolean|-|
+|layout|表单项布局|"horizontal" \| "vertical" \| "inline"|"horizontal"|
+|children|表单项子节点|ReactElement\<any, string \| ((props: any) =\> ReactElement\<any, any\>) \| (new (props: any) =\> Component\<any, any, any\>)\>|必填|
+|shouldUpdate|表单项是否刷新|IShouldUpdateFunc|-|
+|rules|表单项规则|IRules\[\]|-|
+|extra|表单项下方节点|ReactElement\<any, string \| ((props: any) =\> ReactElement\<any, any\>) \| (new (props: any) =\> Component\<any, any, any\>)\>|-|
+|trigger|触发事件更新事件名称|string|"onChange"|
+|requiredIcon|自定义必填标识|ReactNode|-|
+|initialValue|表单项初始数据|any|-|
+|displayType|手动指定为内置组件的类型|"Input" \| "Textarea" \| "Checkbox" \| "CheckboxGroup" \| "DatePicker" \| "Picker" \| "Radio" \| "RadioGroup" \| "Slider" \| "Switch" \| "ImagePicker" \| "Rate" \| "Stepper"|-|
+
+> IFormInstance
+
+|参数|描述|类型|
+|----------|-------------|------|
+|getFieldValue|获取单个表单项值|(name: string) =\> any|
+|getFieldsValue|获取多个表单项值|(name?: string\[\]) =\> Record\<string, any\>|
+|getFieldError|获取单个表单项的错误|(name: string) =\> ReactNode\[\]|
+|resetFields|重置表单项|() =\> void|
+|setFieldValue|设置单个表单项值|(name: string, value: any) =\> boolean|
+|setFieldsValue|设置多个表单项值|(value: Record\<string, any\>) =\> void|
+|validateFields|校验所有表单项|() =\> Promise\<IFieldError\[\]\>|
+|submit|提交表单|() =\> void|
+
+> IFieldError
+
+|参数|描述|类型|
+|----------|-------------|------|
+|value|-|any|
+|errors|-|ReactNode\[\]|
+|warnings|-|ReactNode\[\]|
+|field|-|string|
+|dom|-|HTMLDivElement|
+
+> IRules
+
+```
+ITypeRules<ValidatorType.Number> | ITypeRules<ValidatorType.String> | ITypeRules<ValidatorType.Array> | ITypeRules<ValidatorType.Boolean> | ITypeRules<ValidatorType.Object> | ITypeRules<ValidatorType.Custom>
+```
+
+> FormInternalComponentType
+
+```
+"Input" | "Textarea" | "Checkbox" | "CheckboxGroup" | "DatePicker" | "Picker" | "Radio" | "RadioGroup" | "Slider" | "Switch" | "ImagePicker" | "Rate" | "Stepper"
+```
+
+> FormItemRef
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|

package/metaData/components/grid/api.md

@@ -0,0 +1,31 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|data|传入的数据|GridData\[\]|必填|
+|columns|一行的列数|number|3|
+|border|是否有边框|boolean|false|
+|gutter|格子间的间距|number \| \{ x: number; y: number; \}|0|
+|shape|格子的形状，可选值为 circle|string|"square"|
+|isSliding|溢出时是否支持滑动|boolean|false|
+|direction|格子内容排列的方向，可选值为 horizontal|string|"vertical"|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+
+> GridData
+
+|参数|描述|类型|
+|----------|-------------|------|
+|img|传入图标的资源地址|ReactNode|
+|title|传入的标题文字内容|ReactNode|
+|content|传入的描述文字内容|ReactNode|
+|className|自定义样式|string|
+|onClick|点击后的回调函数|(item: GridData) =\> void|
+|itemStyle|每个格子自定义样式|CSSProperties|
+|renderGrid|自定义单个 grid 的创建函数|(item: GridData, colIndex: number, rowIndex: number) =\> ReactNode|

package/metaData/components/icon/api.md

@@ -0,0 +1,7 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|节点类名|string|-|
+|useCurrentColor|fill值是否使用color属性值，否则保留原有颜色|boolean|true|
+|style|自定义样式|React.CSSProperties|-|