@fjyueke/arco-mcp 1.0.0 → 1.0.1

package/metaData/components/action-sheet/api.md

@@ -0,0 +1,94 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|items|选项配置，详情见 ActionSheetItemOptions|ActionSheetItemOptions\[\]|必填|
+|cancelText|取消按钮内容，传值则会展示，点击后关闭动作面板|ReactNode|-|
+|title|面板标题内容|ReactNode|-|
+|subTitle|面板副标题内容|ReactNode|-|
+|needBottomOffset|从底部滑出的菜单内容是否适配ipx底部|boolean|true|
+|unmountOnExit|是否在退出时卸载内容|boolean|true|
+|getContainer|获取挂载容器|() =\> HTMLElement|-|
+|onClose|关闭后回调（动画执行完毕）|(scene?: string) =\> void|-|
+|visible|是否展示菜单（受控）|boolean|必填|
+|close|关闭菜单方法|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> void|必填|
+|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|-|
+|maskClosable|点击蒙层是否关闭菜单|boolean|true|
+|animatingClosable|执行进场动画时点击蒙层是否可关闭菜单|boolean|false|
+|mountOnEnter|是否在打开菜单时再加载内容|boolean|true|
+|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|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+
+> 方法/Methods
+
+|方法名|描述|类型|
+|----------|-------------|------|
+|open|打开动作面板|(config: ActionSheetProps) =\> \{ close: () =\> void; update: (newConfig: ActionSheetProps) =\> void; \}|
+
+> ActionSheetItemOptions
+
+|参数|描述|类型|
+|----------|-------------|------|
+|content|选项文字内容|ReactNode|
+|status|状态，disabled 状态下不可点，danger 状态字体飘红|"normal" \| "disabled" \| "danger"|
+|className|选项文字自定义类名|string|
+|style|选项文字自定义样式|CSSProperties|
+|onClick|点击选项事件，返回值为 true 时可以阻止动作面板关闭|(e?: MouseEvent\<HTMLElement, MouseEvent\>) =\> boolean \| void \| Promise\<boolean \| void\>|
+
+> GlobalContextParams
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|prefixCls|组件类名前缀|string|"arco"|
+|system|手动控制当前所在系统，传入后将直接使用传入的值，ssr场景需指定系统初始值时适用|"" \| "pc" \| "android" \| "ios"|""|
+|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|-|
+
+> 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; \}|

package/metaData/components/avatar/api.md

@@ -0,0 +1,49 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|shape|形状|"circle" \| "square"|"circle"|
+|size|尺寸|"medium" \| "large" \| "small" \| "smaller" \| "ultra\-small"|"small"|
+|src|图片头像的资源地址|string|-|
+|imageProps|图片头像组件参数，透传给Image组件|Partial\<ImageProps & RefAttributes\<ImageRef\>\>|-|
+|decoration|图片头像上的装饰|ReactNode|null|
+|textAvatar|文字头像，中文建议取两个字，英文建议在三个字以下|string|""|
+|avatarStyle|头像元素的自定义样式|CSSProperties|{}|
+|avatarClass|头像元素的自定义类名|string|""|
+|autoFixFontSize|是否自动根据头像尺寸调整字体大小|boolean|true|
+|autoFixFontOffset|自动调整文字头像大小时，文字距离头像容器左右的安全距离|number|2|
+|avatarName|头像旁的用户名信息|string|""|
+|avatarDesc|头像旁的辅助信息，需要和用户名一起出现|string|""|
+|renderInfo|自定义头像描述信息|ReactNode|null|
+|defaultOverLap|头像组件为空时默认的状态|ReactNode|用户图标|
+|onClick|点击头像的回调事件|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> void|() => {}|
+|onClickDecoration|点击头像上的装饰|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> void|() => {}|
+|children|自定义组件内容|ReactNode|null|
+|className|自定义类名|string|""|
+|style|自定义样式|CSSProperties|{}|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|组件外层dom元素|HTMLDivElement|
+
+> Avatar.Group
+
+头像叠层
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|isGroup|是否为头像组|boolean|必填|
+|shape|形状，优先级低于Avatar组件本身|"circle" \| "square"|"circle"|
+|size|尺寸，优先级低于Avatar组件本身|"medium" \| "large" \| "small" \| "smaller" \| "ultra\-small"|"medium"|
+|zIndexOrder|头像组叠层层级顺序，z\-index值大小，desc \- 降序，asc \- 升序|"desc" \| "asc"|"desc"|
+|children|自定义组件内容|ReactNode|null|
+|className|自定义类名|string|""|
+|style|自定义样式|CSSProperties|{}|
+
+> AvatarGroupRef
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|组件外层dom元素|HTMLDivElement|

package/metaData/components/badge/api.md

@@ -0,0 +1,20 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|visible|是否展示徽标，visible切换时有动画过渡|boolean|true|
+|text|徽标文案|ReactText|-|
+|dot|显示为一个小红点|boolean|false|
+|maxCount|最大完整展示数字，超出后将展示 \+|number|99|
+|children|内容|ReactNode|-|
+|absolute|是否置于右上角|boolean|false|
+|bordered|是否有白色边框|boolean|false|
+|timeout|动画持续时间(ms)|number \| \{ appear?: number; enter?: number; exit?: number; \}|300|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|

package/metaData/components/button/api.md

@@ -0,0 +1,37 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|type|样式类型|"primary" \| "ghost" \| "default"|"primary"|
+|size|尺寸|"mini" \| "small" \| "medium" \| "large" \| "huge"|"large"|
+|inline|是否为内联样式|boolean|false|
+|loading|是否处于加载中状态|boolean|false|
+|disabled|是否禁用|boolean|false|
+|halfBorder|border是否为0\.5px|boolean|false|
+|icon|图标名，传入Icon组件|ReactNode|-|
+|showTextWhenLoading|加载中是否展示文字|boolean|true|
+|needActive|是否需要点击态|boolean|true|
+|style|自定义样式|CSSProperties|-|
+|shape|按钮形状|"round" \| "semi" \| "square"|"semi"|
+|color|自定义字体颜色|ButtonColorStatus|-|
+|bgColor|自定义背景颜色|ButtonColorStatus|-|
+|borderColor|自定义边框颜色|ButtonColorStatus|-|
+|className|自定义类名|string|-|
+|loadingIcon|加载图标，传入Icon组件type属性或node|ReactNode|-|
+|children|子元素|ReactNode|-|
+|onClick|点击按钮的回调函数|(e: MouseEvent\<Element, MouseEvent\>) =\> void|-|
+|onClickDisabled|禁用状态下点击按钮的回调函数|(e: MouseEvent\<Element, MouseEvent\>) =\> void|-|
+|disableWhenLoading|加载中是否禁用按钮操作|boolean|true|
+|coverIconWhenLoading|加载中是否覆盖Icon|boolean|true|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLButtonElement|
+
+> ButtonColorStatus
+
+```
+string | { normal: string; active: string; disabled: string; }
+```

package/metaData/components/carousel/api.md

@@ -0,0 +1,81 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|样式类名|string|-|
+|wrapStyle|最外层容器自定义样式|CSSProperties|-|
+|style|内层轮播容器自定义样式|CSSProperties|-|
+|children|轮播内部内容|ReactNode|-|
+|list|轮播图片列表，省略子元素的简写，传入图片url数组，也可通过\`text\`指定图片底部的蒙层文字内容|CarouselListItem\[\]|-|
+|animateDuration|自动切换轮播滑块时，动画的执行时间(ms)|number|500|
+|animateDurationSlide|手动切换轮播滑块时，当手指释放后，动画的执行时间(ms)|number|300|
+|loop|是否开启循环轮播，当指定轮播滑块宽度时该属性不生效|boolean|true|
+|autoPlay|是否开启自动播放|boolean|true|
+|autoPlayDirection|自动播放方向|"normal" \| "reverse"|"normal"|
+|swipeable|是否响应手势滑动|boolean|true|
+|stayDuration|开启自动播放时，每一个滑块的停留时间(ms)|number|4000|
+|boxWidth|指定容器宽度，默认为基于父容器100%|ReactText|-|
+|boxHeight|指定容器高度，默认为自适应高度；当设置\`vertical=true\`时，该属性为必填|ReactText|-|
+|baseBoxWidth|指定初始容器宽度，常用于ssr首屏初始化，水平轮播时可用|number|-|
+|baseBoxHeight|指定初始容器宽度，常用于ssr首屏初始化，垂直轮播时可用|number|-|
+|width|指定轮播滑块宽度，为0或不传时为默认的父容器宽度|number|0|
+|height|指定轮播滑块高度，如不指定则为自适应高度|number|-|
+|initialIndex|默认选中的滑块索引|number|0|
+|renderIndicator|自定义轮播索引|(currentIndex: number, total: number, lastIndex: number) =\> ReactNode|-|
+|indicatorPos|轮播索引位置|"start" \| "center" \| "end"|"center"|
+|indicatorVerticalPos|垂直轮播索引横向位置|"left" \| "right"|"left"|
+|indicatorOutside|轮播索引是否放轮播图外面|boolean|-|
+|showIndicator|是否展示轮播索引|boolean|true|
+|hideSingleIndicator|children 只有一个时隐藏轮播索引|boolean|true|
+|indicatorType|轮播索引样式类型|"square" \| "circle"|"square"|
+|indicatorClass|轮播索引类名|string|-|
+|indicatorInverse|轮播索引是否反色，默认根据索引是否放在外面决定|boolean|-|
+|spaceBetween|子元素间距|number|0|
+|offsetBetween|前后两端露出距离，设置值时不能循环轮播|number \| \{ left?: number; right?: number; \}|0|
+|currentIndex|手动控制当前展示元素|number|-|
+|autoHeight|容器高度自适应|boolean|false|
+|percentToChange|滑动切换距离阈值(宽度比例)，范围为\[0, 1\]，如果该属性和\`distanceToChange\`属性均设置，则实际计算结果更大的生效|number|0.3|
+|distanceToChange|滑动切换距离阈值(固定px宽度)，如果该属性和\`percentToChange\`属性均设置，则实际计算结果更大的生效|number|10|
+|speedToChange|滑动切换速度阈值(手指从按下到抬起之间的滑动速度，单位为px/s)，与滑动切换距离阈值同时设置时，满足其中一个即生效|number|200|
+|vertical|是否垂直轮播，设置后\`boxHeight\`属性必填|boolean|-|
+|lazyloadCount|只加载当前页相邻的n个内容，为0时会销毁所有相邻内容，不传则加载所有内容|number|-|
+|stopTouchThreshold|触发onTouchStopped的最小阈值|number|0|
+|bounceWhenNoLoop|当不可循环时，是否开启滑动到最前或最后时的回弹效果|boolean|false|
+|bounceDampRate|当开启最前或最后时的回弹效果时的阻尼系数|number|3|
+|inactiveScale|非active的滑块的大小比例，\[0, 1\]的小数，设置后切换时将有放大效果|number|-|
+|stopPropagation|触摸事件是否需要 stopPropagation|boolean|true|
+|fakeItem|是否需要fake首尾item，用于offsetBetween不等于0时循环轮播的衔接|boolean|false|
+|allowEndBlank|滑动到最后时是否允许留白，仅在loop=false且设置了width时有效|boolean|false|
+|iOSVisibleOptimize|在iOS下是否需要在切屏时做DOM强刷优化，用于修复iOS息屏时自动播放的蜜汁渲染问题|boolean|true|
+|renderExtra|在轮播图内部渲染额外元素，该元素不随轮播滑动，但处于手指可交互热区|(currentIndex: number) =\> ReactNode|-|
+|distanceProcessor|自定义手指滑动跟手的距离计算方式，posDis表示touchmove的距离，wrapSize表示容器在滑动方向的尺寸，childSize表示滑块在滑动方向的尺寸|(posDis: number, wrapSize: number, childSize: number) =\> number|(posDis, wrapSize, childSize) => childSize * (posDis / wrapSize)|
+|getInnerScrollContainer|组件内部的滚动容器，用于豁免滑动事件响应|() =\> HTMLElement \| HTMLElement\[\]|-|
+|onTouchStopped|当轮播不支持循环且滑到最前面或最后面，还想再滑动时触发|(direction: 1 \| \-1) =\> void|-|
+|onChange|轮播滑块切换时触发|(index: number) =\> void|-|
+|onAfterChange|轮播滑块切换，动画完成后触发|(index: number, oldIndex: number) =\> void|-|
+|onTouchStart|轮播内容touchstart事件|(e: TouchEvent, total: number, index: number) =\> boolean \| void|-|
+|onTouchMove|轮播内容touchmove事件|(e: TouchEvent, total: number, index: number) =\> boolean \| void|-|
+|onTouchEnd|轮播内容touchend / touchcancel事件|(e: TouchEvent, total: number, index: number) =\> boolean \| void|-|
+|onTransitionStart|轮播切换动画开始时回调|() =\> void|-|
+|onTransitionEnd|轮播切换动画结束时回调|() =\> void|-|
+|onDistanceChange|轮播左右滑动时回调，用于监听滑动距离以做滑动同步交互|(distance: number, wrapSize: number, activeIndex: number) =\> void|-|
+|onPageVisibleChange|自定义页面展示隐藏监听，默认在document监听visibilitychange事件，返回function用于在组件卸载时移除监听|(updateWhenVisible: () =\> void, updateWhenInvisible: () =\> void) =\> () =\> void|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|wrap|轮播图子项包裹容器 DOM，承载了 touch 相关事件|HTMLDivElement|
+|items|轮播图每个子项的 DOM|HTMLDivElement\[\]|
+|noLoop|在某些条件下内部会禁用循环轮播，这里表示循环是否被禁用|boolean|
+|updateData|手动重新计算布局|() =\> void|
+|changeIndex|手动更新当前选中索引，rightNow 表示是否立刻跳转到目标索引，否则执行过渡动画到目标索引|(newIndex: number, rightNow?: boolean, direction?: "left" \| "right") =\> void|
+
+> CarouselListItem
+
+|参数|描述|类型|
+|----------|-------------|------|
+|src|图片链接|string|
+|text|图片底部固定的文字|ReactNode|
+|onClick|点击图片回调|(e: MouseEvent\<HTMLImageElement, MouseEvent\>) =\> void|

package/metaData/components/cell/api.md

@@ -0,0 +1,60 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|style|自定义样式|CSSProperties|-|
+|className|自定义类名|string|-|
+|icon|单元格左侧图标|ReactNode|-|
+|label|标签名|ReactNode|-|
+|desc|描述|ReactNode|-|
+|text|主体文字，如果有标签名则靠右，否则靠左|string|-|
+|children|主体内容，如果有标签名则靠右，否则靠左|ReactNode|-|
+|showArrow|是否展示右侧箭头|boolean|-|
+|arrow|右侧箭头内容|ReactNode|-|
+|prepend|单元格前缀内容，在单元格上方|ReactNode|-|
+|append|单元格后缀内容，在单元格下方|ReactNode|-|
+|bordered|是否有外边框|boolean|true|
+|onClick|点击单元格事件回调|(e: MouseEvent\<HTMLDivElement, MouseEvent\>) =\> void|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+
+> Cell.Group
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|style|自定义样式|CSSProperties|-|
+|className|自定义类名|string|-|
+|header|自定义头部内容|ReactNode|-|
+|footer|自定义尾部内容|ReactNode|-|
+|bordered|是否有外边框|boolean|true|
+|options|单元格配置，优先级高于children|(CellProps & RefAttributes\<CellRef\>)\[\]|-|
+|children|内部单元格|ReactNode|-|
+|onClick|点击单元格组回调|(e: MouseEvent\<HTMLDivElement, MouseEvent\>) =\> void|-|
+
+> CellProps
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|style|自定义样式|CSSProperties|-|
+|className|自定义类名|string|-|
+|icon|单元格左侧图标|ReactNode|-|
+|label|标签名|ReactNode|-|
+|desc|描述|ReactNode|-|
+|text|主体文字，如果有标签名则靠右，否则靠左|string|-|
+|children|主体内容，如果有标签名则靠右，否则靠左|ReactNode|-|
+|showArrow|是否展示右侧箭头|boolean|-|
+|arrow|右侧箭头内容|ReactNode|-|
+|prepend|单元格前缀内容，在单元格上方|ReactNode|-|
+|append|单元格后缀内容，在单元格下方|ReactNode|-|
+|bordered|是否有外边框|boolean|true|
+|onClick|点击单元格事件回调|(e: MouseEvent\<HTMLDivElement, MouseEvent\>) =\> void|-|
+
+> CellGroupRef
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|

package/metaData/components/checkbox/api.md

@@ -0,0 +1,83 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|label|选项的文字说明，传入children时此属性无效|string|""|
+|value|Checkbox的值|ValueType|必填|
+|defaultCheck|默认选中状态|boolean|false|
+|checked|是否选中，传值即为受控模式|boolean|-|
+|onChange|复选框选中状态回调函数|(checked: boolean, value: ValueType, e: MouseEvent\<Element, MouseEvent\>) =\> void|() => {}|
+|shape|图标的形状|"circle" \| "square"|'circle'|
+|layout|排版样式(内联\|块级\|图标靠右两端对齐)|"inline" \| "block" \| "justify"|'inline'|
+|disabled|是否禁用|boolean|false|
+|icons|自定义图标合集，传 null 表示无图标|IconType|Default icon|
+|isRadio|是否为Radio组件，不推荐使用，仅用于支持Radio组件|boolean|false|
+|children|自定义组件内容|ReactNode|null|
+|className|自定义类名|string|""|
+|style|自定义样式|CSSProperties|{}|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|组件外层dom元素|HTMLDivElement|
+
+> Checkbox.Group
+
+复选项组
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|options|复选框组可选项, 传入children后此值无效|(CheckboxProps\<ValueType\> & RefAttributes\<CheckboxRef\>)\[\]|-|
+|value|受控模式，复选框选中的选项值|ValueType\[\]|-|
+|defaultValue|默认选中项|ValueType\[\]|[]|
+|min|最小可选值数量|number|0|
+|max|最大可选值数量，0表示没有限制|number|0|
+|onChange|点击复选框值变化回调|(value: ValueType\[\]) =\> void|() => {}|
+|shape|图标的形状|"circle" \| "square"|'circle'|
+|layout|排版样式(内联\|块级\|图标靠右两端对齐)|"inline" \| "block" \| "justify"|'inline'|
+|disabled|是否禁用|boolean|false|
+|icons|自定义图标合集，传 null 表示无图标|IconType|Default icon|
+|isRadio|是否为Radio组件，不推荐使用，仅用于支持Radio组件|boolean|false|
+|children|自定义组件内容|ReactNode|null|
+|className|自定义类名|string|""|
+|style|自定义样式|CSSProperties|{}|
+
+> ValueType
+
+```
+string | number
+```
+
+> IconType
+
+|参数|描述|类型|
+|----------|-------------|------|
+|normal|未选中|ReactNode|
+|active|选中态|ReactNode|
+|disabled|禁用态|ReactNode|
+|activeDisabled|禁用选中态|ReactNode|
+
+> CheckboxProps
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|label|选项的文字说明，传入children时此属性无效|string|""|
+|value|Checkbox的值|ValueType|必填|
+|defaultCheck|默认选中状态|boolean|false|
+|checked|是否选中，传值即为受控模式|boolean|-|
+|onChange|复选框选中状态回调函数|(checked: boolean, value: ValueType, e: MouseEvent\<Element, MouseEvent\>) =\> void|() => {}|
+|shape|图标的形状|"circle" \| "square"|'circle'|
+|layout|排版样式(内联\|块级\|图标靠右两端对齐)|"inline" \| "block" \| "justify"|'inline'|
+|disabled|是否禁用|boolean|false|
+|icons|自定义图标合集，传 null 表示无图标|IconType|Default icon|
+|isRadio|是否为Radio组件，不推荐使用，仅用于支持Radio组件|boolean|false|
+|children|自定义组件内容|ReactNode|null|
+|className|自定义类名|string|""|
+|style|自定义样式|CSSProperties|{}|
+
+> CheckboxGroupRef
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|组件外层dom元素|HTMLDivElement|

package/metaData/components/circle-progress/api.md

@@ -0,0 +1,32 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|percentPosition|文字显示位置|"center" \| "bottom"|"center"|
+|showPercent|是否显示圆环内部文字|boolean|true|
+|percentage|进度环百分比|number|必填|
+|renderPercent|圆环内部文字显示（一个函数，返回ReactNode类型，回调参数为当前进度百分比）|(percentage: number) =\> ReactNode|-|
+|trackColor|轨道颜色|string|-|
+|progressColor|进度环颜色|string|-|
+|disabled|是否置灰|boolean|false|
+|trackStroke|轨道宽度|number|10|
+|progressStroke|进度环宽度|number|12|
+|progressColorStart|进度环渐变开始的颜色(当设置progressColorStart和progressColorEnd其中一个时，颜色会覆盖掉progressColor的颜色)|string|-|
+|progressColorEnd|进度环渐变结束的颜色|string|-|
+|duration|每增加step步长所需的毫秒数|number|30|
+|step|步长（增加步长，以step增长）|number|1|
+|clockwise|是否逆时针增加|boolean|false|
+|radius|圆环半径|number|-|
+|filleted|进度条两端是否圆角|boolean|true|
+|mountedTransition|初始化percentage时是否以动画形式过渡到目的值|boolean|true|
+|size|进度环尺寸|"mini" \| "default"|"default"|
+|mountedBezier|初始化时动画的贝塞尔曲线|\[number, number, number, number\]|[0.34, 0.69, 0.1, 1]|
+|svgKey|区分不同svg的\`\<def\>\`内容|string|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|

package/metaData/components/collapse/api.md

@@ -0,0 +1,66 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|header|标题|ReactNode|-|
+|value|折叠面板的唯一标识|string|必填|
+|icon|折叠面板的展开图标|ReactNode|-|
+|hideIcon|是否隐藏图标|boolean|false|
+|disabled|是否不可展开|boolean|false|
+|content|面板内容|ReactNode|必填|
+|active|是否展开|boolean|-|
+|defaultActive|默认展开情况|boolean|false|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|onCollapse|可选受控，展开折叠面板时触发|(value: string) =\> void|-|
+|animationTimeout|动画时间|number|-|
+|animationFunction|动画函数|string|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|组件外层dom元素|HTMLDivElement|
+|head|折叠面板头部元素|HTMLDivElement|
+|updateLayout|手动更新组件布局(高度计算)|() =\> void|
+
+> Collapse.Group
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|onCollapse|可选受控，展开折叠面板时触发|(value: string) =\> void|-|
+|animationTimeout|动画时间|number|-|
+|animationFunction|动画函数|string|-|
+|useAccordion|是否使用手风琴模式|boolean|false|
+|activeItems|可选受控，可传展开的item数组，或者每个item对应的状态|string\[\]|-|
+|defaultActiveItems|默认状态|string\[\]|-|
+|disabled|一键禁用|boolean|false|
+|items|折叠面板数组|(CollapseProps & RefAttributes\<CollapseRef\>)\[\]|-|
+|children|子元素，优先级高于items|ReactNode|-|
+|groupKey|区分不同 group，有group 嵌套时建议传入|string|-|
+
+> CollapseProps
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|header|标题|ReactNode|-|
+|value|折叠面板的唯一标识|string|必填|
+|icon|折叠面板的展开图标|ReactNode|-|
+|hideIcon|是否隐藏图标|boolean|false|
+|disabled|是否不可展开|boolean|false|
+|content|面板内容|ReactNode|必填|
+|active|是否展开|boolean|-|
+|defaultActive|默认展开情况|boolean|false|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|onCollapse|可选受控，展开折叠面板时触发|(value: string) =\> void|-|
+|animationTimeout|动画时间|number|-|
+|animationFunction|动画函数|string|-|
+
+> CollapseGroupRef
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|-|HTMLDivElement|

package/metaData/components/context-provider/api.md

@@ -0,0 +1,36 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|prefixCls|组件类名前缀|string|"arco"|
+|system|手动控制当前所在系统，传入后将直接使用传入的值，ssr场景需指定系统初始值时适用|"" \| "pc" \| "android" \| "ios"|""|
+|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|-|
+
+> 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; \}|

package/metaData/components/count-down/api.md

@@ -0,0 +1,32 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|time|倒计时时长，单位毫秒|number \| TimeDataType|0|
+|format|自定义格式 D:天数 DD:天数（个位数补0） H:小时 HH:小时（个位数补0） m:分钟 mm:分钟（个位数补0） s:秒数 ss:秒数（个位数补0） S:毫秒（1 位）SS:毫秒（2 位）SSS:毫秒（3 位）|string|HH:mm:ss|
+|autoStart|是否自动开始倒计时|boolean|true|
+|millisecond|是否开启毫秒级渲染|boolean|false|
+|onFinish|倒计时结束时触发|() =\> void|-|
+|onChange|倒计时变化时触发|(val: TimeDataType, ts: number) =\> void|-|
+|renderChild|自定义内容|(val: TimeDataType) =\> ReactNode|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|start|开始|() =\> void|
+|pause|暂停|() =\> void|
+|reset|重置|() =\> void|
+
+> TimeDataType
+
+|参数|描述|类型|
+|----------|-------------|------|
+|days|天数|number|
+|hours|小时|number|
+|minutes|分钟|number|
+|seconds|秒数|number|
+|milliseconds|毫秒|number|