@fjyueke/arco-mcp 1.0.0 → 1.0.1

package/metaData/components/image/api.md

@@ -0,0 +1,54 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|style|自定义样式|CSSProperties|-|
+|className|自定义类名|string|-|
+|status|指定图片状态，staticLabel=false时有效|"loading" \| "loaded" \| "init" \| "error"|-|
+|src|图片链接|string|必填|
+|width|容器宽度，传数值，默认单位为px，传字符串则接受传入的单位|ReactText|-|
+|height|容器高度，传数值，默认单位为px，传字符串则接受传入的单位|ReactText|-|
+|alt|替代文本|string|""|
+|fit|图片填充模式(object\-fit)，传preview\-\*为预览模式，预览模式仅staticLabel=false时有效|"\-moz\-initial" \| "inherit" \| "initial" \| "revert" \| "revert\-layer" \| "unset" \| "contain" \| "cover" \| "fill" \| "none" \| "scale\-down" \| "preview\-y" \| "preview\-x"|"fill"|
+|position|图片填充位置(object\-position)|ObjectPosition\<ReactText\>|"center"|
+|radius|图片圆角|ReactText|-|
+|bordered|是否加边框|boolean|-|
+|loadingArea|自定义展示加载中内容|ReactNode|-|
+|errorArea|自定义展示加载失败内容|ReactNode|-|
+|showLoading|是否展示图片加载中提示|boolean|-|
+|showError|是否展示图片加载失败提示|boolean|-|
+|animateDuration|加载完时展现动画时长，staticLabel=false时有效|number|200|
+|retryTime|失败时自动重试次数|number|0|
+|forceHttps|是否强制使用https|boolean|-|
+|boxWidth|预览模式下，父容器宽度|number|-|
+|boxHeight|预览模式下，父容器高度|number|-|
+|topOverlap|图片顶层内容|ReactNode|-|
+|bottomOverlap|图片底层内容（placeholder），默认是灰色兜底，传null可移除|ReactNode|-|
+|showImage|手动控制是否加载图片|boolean|-|
+|staticLabel|是否直接渲染\<img\>标签，不走加载图片流程|boolean|-|
+|nativeProps|img标签原生属性，优先级低于单独设置|DetailedHTMLProps\<ImgHTMLAttributes\<HTMLImageElement\>, HTMLImageElement\>|-|
+|onChange|切换status时触发的回调|(status: string) =\> void|-|
+|onClick|点击图片时触发的回调|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> void|-|
+|onLoad|图片加载完毕时触发的回调|(e: Event, image: HTMLImageElement) =\> void|-|
+|onError|图片加载失败时触发的回调，如果有自动重试则在重试最终失败后触发|(e: string \| Event) =\> void|-|
+|onAutoRetry|图片加载失败时自动重试触发的回调|(e: string \| Event) =\> void|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|image|原生图片元素 DOM|HTMLImageElement|
+|retry|手动重试图片加载|() =\> void|
+
+> ImageStatus
+
+```
+"loading" | "loaded" | "init" | "error"
+```
+
+> ObjectPosition
+
+```
+string | number | string & {}
+```

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

@@ -0,0 +1,108 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|images|已选择图片列表|ImagePickItem\[\]|必填|
+|accept|可以选择的文件类型|string|'image/*'|
+|multiple|是否支持多选|boolean|-|
+|capture|图片选取模式 Image selection mode \[capture MDN\](https://developer\.mozilla\.org/en\-US/docs/Web/HTML/Attributes/capture)|string \| boolean|-|
+|columns|一行展示图片张数|number|3|
+|gutter|格子间的间距|number|8|
+|hideDelete|是否隐藏删除Icon|boolean|false|
+|hideSelect|是否隐藏选择Icon|boolean|false|
+|alwaysShowSelect|是否总是展示选择Icon，默认情况下当图片数量超出limit值时会自动隐藏选择Icon|boolean|false|
+|disabled|禁用选择和删除图片|boolean|-|
+|deleteIcon|自定义删除图标|ReactNode|-|
+|selectIcon|自定义选择图标|ReactNode|-|
+|imageProps|透传给图片的属性|Partial\<ImageProps\>|-|
+|renderError|自定义上传失败展示|(index?: number) =\> ReactNode|-|
+|renderLoading|自定义上传中展示|(index?: number) =\> ReactNode|-|
+|onSelectClick|选图点击事件(同onUploadClick)|() =\> void|-|
+|onUploadClick|选图点击事件|() =\> void|-|
+|upload|上传方法|(file: ImagePickItem) =\> Promise\<ImagePickItem\>|-|
+|onChange|已选文件列表发生变化|(fileList: ImagePickItem\[\]) =\> void|-|
+|maxSize|文件大小限制，单位为K|number|-|
+|onMaxSizeExceed|文件超过限制大小|(file: File) =\> void|-|
+|limit|最多选择文件数，超出数量自动隐藏上传按钮，0表示不做限制|number|0|
+|onLimitExceed|选择文件数超过限制|(files: File\[\]) =\> void|-|
+|onDeleteClick|删除点击事件|(index: number) =\> void|-|
+|selectAdapter|文件选择适配器|() =\> Promise\<SelectCallback\>|-|
+|onClick|文件点击|(e: MouseEvent\<HTMLElement, MouseEvent\>, file: ImagePickItem, index: number) =\> void|-|
+|onLongPress|文件长按事件|(e: TouchEvent\<HTMLElement\>, file: ImagePickItem, index: number) =\> void|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层 DOM 元素|HTMLDivElement|
+
+> ImagePickItem
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|url|图片地址|string|必填|
+|file|文件|File|-|
+|status|文件状态|"loaded" \| "loading" \| "error"|以文件自身加载状态而定|
+
+> ImageProps
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|style|自定义样式|CSSProperties|-|
+|className|自定义类名|string|-|
+|status|指定图片状态，staticLabel=false时有效|"loaded" \| "loading" \| "error" \| "init"|-|
+|src|图片链接|string|必填|
+|width|容器宽度，传数值，默认单位为px，传字符串则接受传入的单位|ReactText|-|
+|height|容器高度，传数值，默认单位为px，传字符串则接受传入的单位|ReactText|-|
+|alt|替代文本|string|""|
+|fit|图片填充模式(object\-fit)，传preview\-\*为预览模式，预览模式仅staticLabel=false时有效|"\-moz\-initial" \| "inherit" \| "initial" \| "revert" \| "revert\-layer" \| "unset" \| "contain" \| "cover" \| "fill" \| "none" \| "scale\-down" \| "preview\-y" \| "preview\-x"|"fill"|
+|position|图片填充位置(object\-position)|ObjectPosition\<ReactText\>|"center"|
+|radius|图片圆角|ReactText|-|
+|bordered|是否加边框|boolean|-|
+|loadingArea|自定义展示加载中内容|ReactNode|-|
+|errorArea|自定义展示加载失败内容|ReactNode|-|
+|showLoading|是否展示图片加载中提示|boolean|-|
+|showError|是否展示图片加载失败提示|boolean|-|
+|animateDuration|加载完时展现动画时长，staticLabel=false时有效|number|200|
+|retryTime|失败时自动重试次数|number|0|
+|forceHttps|是否强制使用https|boolean|-|
+|boxWidth|预览模式下，父容器宽度|number|-|
+|boxHeight|预览模式下，父容器高度|number|-|
+|topOverlap|图片顶层内容|ReactNode|-|
+|bottomOverlap|图片底层内容（placeholder），默认是灰色兜底，传null可移除|ReactNode|-|
+|showImage|手动控制是否加载图片|boolean|-|
+|staticLabel|是否直接渲染\<img\>标签，不走加载图片流程|boolean|-|
+|nativeProps|img标签原生属性，优先级低于单独设置|DetailedHTMLProps\<ImgHTMLAttributes\<HTMLImageElement\>, HTMLImageElement\>|-|
+|onChange|切换status时触发的回调|(status: string) =\> void|-|
+|onClick|点击图片时触发的回调|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> void|-|
+|onLoad|图片加载完毕时触发的回调|(e: Event, image: HTMLImageElement) =\> void|-|
+|onError|图片加载失败时触发的回调，如果有自动重试则在重试最终失败后触发|(e: string \| Event) =\> void|-|
+|onAutoRetry|图片加载失败时自动重试触发的回调|(e: string \| Event) =\> void|-|
+
+> ImageStatus
+
+```
+"loaded" | "loading" | "error" | "init"
+```
+
+> ObjectPosition
+
+```
+string | number | string & {}
+```
+
+> SelectCallback
+
+|参数|描述|类型|
+|----------|-------------|------|
+|files|文件列表|AdapterFile\[\]|
+
+> AdapterFile
+
+|参数|描述|类型|
+|----------|-------------|------|
+|url|文件 url|string|
+|size|文件大小|number|
+|name|文件名|string|

package/metaData/components/image-preview/api.md

@@ -0,0 +1,111 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|style|自定义样式|CSSProperties|-|
+|className|自定义类名|string|-|
+|images|图片信息数组|PreviewImageProps\[\]|必填|
+|openIndex|打开时展示的index，在images范围内会展示弹窗，否则隐藏弹窗|number|必填|
+|loop|是否可循环滑动|boolean|false|
+|fit|图片布局方式，preview\-y为宽度撑满高度溢出滚动，preview\-x为高度撑满宽度溢出滚动|"preview\-y" \| "preview\-x"|"preview-y"|
+|displayDuration|打开和关闭时的过渡动画|number|300|
+|replaceFallbackWhenLoaded|是否在原图加载完成后将过渡图动画替换为原图动画|boolean|-|
+|noselect|图片不可选中，屏蔽系统默认事件|boolean|true|
+|spaceBetween|图片横向间距|number|-|
+|loadingArea|自定义展示加载中内容|ReactNode|-|
+|errorArea|自定义展示加载失败内容|ReactNode|-|
+|showLoading|是否展示图片加载中提示|boolean|true|
+|showError|是否展示图片加载失败提示|boolean|true|
+|retryTime|失败时自动重试次数|number|-|
+|staticLabel|是否直接渲染\<img\>标签，不走加载图片流程|boolean|-|
+|scrollBezier|长图滚动变化曲线|\[number, number, number, number\]|-|
+|lazyloadCount|只加载当前页相邻的n个内容，为0时会销毁所有相邻内容|number|1|
+|swipeToClose|当图片滚动到边缘时，继续滑动是否关闭预览|boolean|true|
+|indicatorPos|轮播索引位置|"start" \| "center" \| "end"|"start"|
+|extra|渲染自定义元素，如自定义关闭按钮|ReactNode|-|
+|getMinScale|图片捏合时最小缩放倍数，松手后仍会恢复到1的状态，默认为0\.7|(image: HTMLImageElement, imageIndex: number) =\> number|-|
+|getMaxScale|图片最大缩放倍数，默认根据图片尺寸调节|(image: HTMLImageElement, imageIndex: number) =\> number|-|
+|getDoubleClickScale|当双击图片时，图片应缩放的倍数|(currentScale: number, maxScale: number, image: HTMLImageElement, imageIndex: number) =\> number|-|
+|getContainer|获取挂载容器|() =\> HTMLElement|-|
+|renderIndicator|自定义索引内容|(currentIndex: number, total: number, lastIndex: number) =\> ReactNode|-|
+|getThumbBounds|获取缩略图定位|(index: number) =\> ClientRect|-|
+|onChange|索引发生改变时回调|(index: number) =\> void|-|
+|onAfterChange|索引切换，动画完成后触发|(index: number) =\> void|-|
+|close|关闭弹窗|(e: MouseEvent\<HTMLDivElement, MouseEvent\> \| TouchEvent) =\> void|必填|
+|onClose|关闭弹窗回调（动画执行完成后）|() =\> void|-|
+|onImageClick|点击图片回调，如果返回true则阻止关闭弹窗|(index: number, e: MouseEvent\<HTMLDivElement, MouseEvent\>) =\> boolean \| void|-|
+|onImageDoubleClick|双击图片回调|(index: number, e: MouseEvent\<HTMLDivElement, MouseEvent\>) =\> void|-|
+|onImageLongTap|长按图片回调|(index: number, image: HTMLImageElement, e: TouchEvent) =\> void|-|
+|onTouchStart|弹窗内容touchstart事件|(e: TouchEvent, index: number) =\> boolean \| void|-|
+|onTouchMove|弹窗内容touchmove事件|(e: TouchEvent, index: number) =\> boolean \| void|-|
+|onTouchEnd|弹窗内容touchend / touchcancel事件|(e: TouchEvent, index: number) =\> boolean \| void|-|
+|animateDurationSlide|手动切换轮播滑块时，当手指释放后，动画的执行时间(ms)|number|300|
+|showIndicator|是否展示轮播索引|boolean|true|
+|hideSingleIndicator|children 只有一个时隐藏轮播索引|boolean|true|
+|percentToChange|滑动切换距离阈值(宽度比例)，范围为\[0, 1\]，如果该属性和\`distanceToChange\`属性均设置，则实际计算结果更大的生效|number|0.3|
+|distanceToChange|滑动切换距离阈值(固定px宽度)，如果该属性和\`percentToChange\`属性均设置，则实际计算结果更大的生效|number|10|
+|speedToChange|滑动切换速度阈值(手指从按下到抬起之间的滑动速度，单位为px/s)，与滑动切换距离阈值同时设置时，满足其中一个即生效|number|200|
+|swipeable|是否响应手势滑动|boolean|true|
+|offsetBetween|前后两端露出距离，设置值时不能循环轮播|number \| \{ left?: number; right?: number; \}|0|
+|renderExtra|在轮播图内部渲染额外元素，该元素不随轮播滑动，但处于手指可交互热区|(currentIndex: number) =\> ReactNode|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|imageDoms|原生图片 DOM 列表|HTMLImageElement\[\]|
+
+> 方法/Methods
+
+|方法名|描述|类型|
+|----------|-------------|------|
+|open|打开图片预览|(config: ImagePreviewProps) =\> \{ close: () =\> void; update: (newConfig: ImagePreviewProps) =\> void; \}|
+
+> PreviewImageProps
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|src|图片地址|string|必填|
+|fit|图片布局方式，preview\-y为宽度撑满高度溢出滚动，preview\-x为高度撑满宽度溢出滚动|"preview\-y" \| "preview\-x"|-|
+|fallbackSrc|过渡图url|string|-|
+|transitionEndDelay|过渡图到原图放大动效完成后，移除过渡图的延迟时间(ms)，一般当原图过大时有调整需求|number|30|
+|thumbPosition|缩略图填充方式（backgroundPosition），默认top center|string|-|
+|extraNode|自定义DOM|ReactNode|-|
+
+> 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/index-bar/api.md

@@ -0,0 +1,75 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|defaultIndex|默认要激活的索引|ReactText|-|
+|disableSidebar|是否开启侧边栏功能|boolean|false|
+|sticky|是否开启索引的自动吸顶效果|boolean|true|
+|groups|索引栏内容|IndexBarGroupItem\<IndexBarBaseData\>\[\]|-|
+|children|自定义内容的渲染，内容必须是IndexBar\.Group组件|ReactNode|-|
+|tipType|侧边栏索引提示的样式类型 \- sweat 水滴形 \- toast 轻提示 \- none 关闭提示|"none" \| "sweat" \| "toast"|"toast"|
+|scrollDuration|手动调用scrollToIndex时，滚动动画的执行时间|number|0|
+|scrollBezier|手动调用scrollToIndex时，滚动的动画曲线|\[number, number, number, number\]|-|
+|onChange|激活的索引改变时的回调，第一个参数是新的索引，第二个参数是改变方式：\- swipe 手动滑动页面触发变化 \- sidebar 侧边栏点击触发变化 \- manual 手动调用scrollToIndex触发|(index: ReactText, trigger: IndexBarChangeTrigger) =\> void|-|
+|onGroupItemClick|IndexBar\.Group中某个子项被点击时的回调，使用JSX的写法时该回调不会生效，请在IndexBar\.Group上绑定对应属性|(index: ReactText, itemData: IndexBarBaseData, itemIndex: number) =\> void|-|
+|renderSideBarItem|自定义侧边栏每个子项的内容渲染|(index: ReactText) =\> ReactNode|-|
+|renderSideBar|自定义侧边栏渲染|(Content: ReactNode) =\> ReactElement\<any, string \| ((props: any) =\> ReactElement\<any, any\>) \| (new (props: any) =\> Component\<any, any, any\>)\>|-|
+|renderTip|自定义使用侧边栏改变索引时，渲染提示的内容|(index: ReactText) =\> ReactNode|-|
+|renderStickyItem|自定义IndexBar\.Group的索引标题内容渲染，使用JSX的写法时该回调不会生效，请在IndexBar\.Group上绑定对应属性|(index: ReactText) =\> ReactNode|-|
+|renderGroupItem|自定义IndexBar\.Group的子项内容渲染，使用JSX的写法时该回调不会生效，请在IndexBar\.Group上绑定对应属性|(index: ReactText, itemData: IndexBarBaseData, itemIndex: number) =\> ReactNode|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层 DOM 元素|HTMLDivElement|
+|scrollToIndex|手动滚动到指定的索引位置|(index?: ReactText, rightNow?: boolean) =\> void|
+|recalculatePosition|局部滚动模式下，如果容器外部还有嵌套滚动，可主动调用此方法，让 sticky 的元素主动更新 fixed 位置|(index?: ReactText) =\> void|
+
+> IndexBar.Group
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|children|自定义内容的渲染，有自定义内容优先渲染自定义内容，否则渲染list传递的数据|ReactNode|-|
+|listKey|自定义提取List的key作为列表渲染的key，默认选取listItem的所在数组位置|(data: IndexBarBaseData, listItemIndex: number) =\> ReactText|-|
+|onGroupItemClick|IndexBar\.Group中某个子项被点击时的回调|(index: ReactText, itemData: IndexBarBaseData, itemIndex: number) =\> void|-|
+|renderStickyItem|自定义IndexBar\.Group的索引标题内容渲染|(index: ReactText) =\> ReactNode|-|
+|renderGroupItem|自定义IndexBar\.Group的子项内容渲染|(index: ReactText, itemData: IndexBarBaseData, itemIndex: number) =\> ReactNode|-|
+|index|IndexBarGroup对应的索引|ReactText|必填|
+|list|IndexBarGroup中要渲染的列表数据，如果已经传递了children这个属性，则list这个属性不会生效|IndexBarBaseData\[\]|-|
+
+> IndexBarGroupItem
+
+|参数|描述|类型|
+|----------|-------------|------|
+|Data|-|any|
+|index|IndexBarGroup对应的索引|ReactText|
+|list|IndexBarGroup中要渲染的列表数据，如果已经传递了children这个属性，则list这个属性不会生效|IndexBarBaseData\[\]|
+
+> IndexBarBaseData
+
+|参数|描述|类型|
+|----------|-------------|------|
+|content|内容|ReactNode|
+
+> IndexBarTipType
+
+```
+"none" | "sweat" | "toast"
+```
+
+> IndexBarChangeTrigger
+
+```
+"swipe" | "manual" | "sidebar"
+```
+
+> IndexBarGroupRef
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|组件外层dom元素|HTMLDivElement|

package/metaData/components/input/api.md

@@ -0,0 +1,52 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|type|输入框类型|string|"text"|
+|pattern|检查控件值的正则表达式|string|-|
+|inputClass|输入框dom自定义类名|string|-|
+|inputStyle|输入框dom自定义样式|CSSProperties|-|
+|nativeProps|其他未列出的原生属性，优先级低于已列出的组件属性|InputHTMLAttributes\<HTMLInputElement\>|-|
+|ariaLabel|无障碍label|string|-|
+|id|输入框的id|string|-|
+|name|输入框的name|string|-|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|value|绑定值，传入即受控|string|-|
+|defaultValue|默认值|string|-|
+|maxLength|最大输入长度|number|-|
+|border|边框展示类型|"all" \| "half" \| "bottom" \| "none"|"half"|
+|placeholder|占位文本|string|-|
+|disabled|输入框是否禁用|boolean|-|
+|readOnly|是否只读|boolean|-|
+|autoFocus|是否自动获取焦点，开启后会触发一次onClick事件|boolean|-|
+|blockChangeWhenCompositing|当 ios 输入中文时，输拼音的过程不触发onChange，仅确认选择后触发|boolean|false|
+|label|输入框左侧文本|ReactNode|-|
+|required|是否必填项|boolean|-|
+|validator|正则验证，不符合验证的不允许输入|RegExp \| ((value: string) =\> boolean)|-|
+|prepend|输入框头部内容，在输入框外部|ReactNode \| ((focusing: boolean, inputValue: string) =\> ReactNode)|-|
+|append|输入框尾部内容，在输入框外部|ReactNode \| ((focusing: boolean, inputValue: string) =\> ReactNode)|-|
+|blurBeforeFocus|在聚焦之前blur掉，即切换不同input时会重新弹起键盘，常用于input type切换时重新加载键盘，安卓上有效|boolean|-|
+|clearable|是否有清除按钮|boolean|-|
+|clearShowType|清除按钮展示时机：focus \- 聚焦时展示 value \- 有值则展示 always \- 始终展示|"focus" \| "value" \| "always"|"focus"|
+|preventEventWhenClearing|在聚焦模式下点击清除按钮时，是否要屏蔽对应产生的onBlur和onFocus事件|boolean|true|
+|clearIcon|清除按钮类型，也可自定义|ReactNode|\<IconClear className="clear-icon" /\>|
+|onClear|按下清除按钮回调|(e: TouchEvent\<HTMLElement\>) =\> void|-|
+|prefix|输入框前置内容，在输入框内部，也可自定义|ReactNode|-|
+|suffix|输入框后置内容，在输入框内部，也可自定义|ReactNode|-|
+|onChange|数据改变时触发（失去焦点时）|(e: ChangeEvent\<HTMLInputElement\>, value: string) =\> void|-|
+|onInput|数据改变时触发|(e: ChangeEvent\<HTMLInputElement\>, value: string) =\> void|-|
+|onFocus|输入框聚焦时触发|(e: FocusEvent\<HTMLInputElement, Element\>) =\> void|-|
+|onBlur|输入框失去焦点时触发|(e: FocusEvent\<HTMLInputElement, Element\>) =\> void|-|
+|onClick|点击输入框事件|(e: MouseEvent\<HTMLInputElement, MouseEvent\>) =\> void|-|
+|onKeyUp|原生的keyup事件|(e: KeyboardEvent\<HTMLInputElement\>) =\> void|-|
+|onKeyDown|原生的keydown事件|(e: KeyboardEvent\<HTMLInputElement\>) =\> void|-|
+|onKeyPress|原生的keypress事件|(e: KeyboardEvent\<HTMLInputElement\>) =\> void|-|
+|onPressEnter|按下回车键时触发|(e: KeyboardEvent\<HTMLInputElement\>) =\> void|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|input|原生输入框 DOM|HTMLInputElement|

package/metaData/components/keyboard/api.md

@@ -0,0 +1,65 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|normalKeyClass|常规键位自定义类名|string|-|
+|normalKeyStyle|常规键位自定义样式|CSSProperties|-|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|type|键盘展示类型，不同类型有不同布局。number \- 纯数字常规键盘，confirm \- 带确认按钮的键盘，tool \- 带运算符的键盘|"number" \| "confirm" \| "tool"|"number"|
+|randomOrder|是否打乱键盘中的数字展示位置|boolean|必填|
+|title|键盘顶部展示标题内容，样式纯自定义|ReactNode|-|
+|rightColumns|自定义渲染数字右侧（第四列）的内容|ReactNode|-|
+|confirmClosable|点击确认后是否自动关闭键盘|boolean|false|
+|confirmButton|自定义渲染确认按钮内部内容|ReactNode|-|
+|deleteButton|自定义渲染删除按钮内部内容|ReactNode|-|
+|keyboardButton|自定义渲染收起键盘按钮内部内容|ReactNode|-|
+|close|收起键盘回调|(e?: MouseEvent\<HTMLElement, MouseEvent\>) =\> \{\}|必填|
+|onConfirm|点击确认按钮回调|() =\> \{\}|-|
+|onDelete|点击删除按钮回调|() =\> \{\}|-|
+|onChange|点击常规按钮回调|(data: ReactText) =\> \{\}|-|
+|direction|菜单滑出方向|"left" \| "right" \| "top" \| "bottom"|"bottom"|
+|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}\`|
+|maskClass|自定义蒙层类名|string|-|
+|maskStyle|自定义蒙层样式|CSSProperties|-|
+|contentClass|自定义内容类名|string|-|
+|contentStyle|自定义内容样式|CSSProperties|-|
+|visible|是否展示菜单（受控）|boolean|必填|
+|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
+
+|参数|描述|类型|
+|----------|-------------|------|
+|keyboard|最外层 DOM 元素|HTMLDivElement|
+|dom|最外层元素 DOM|HTMLDivElement|
+|mask|蒙层 DOM|HTMLDivElement|
+|content|内容 DOM|HTMLDivElement|
+|setCloseScene|在关闭弹窗前修改 onClose 的 scene 参数值|(scene: string) =\> void|
+
+> DirectionType
+
+```
+"left" | "right" | "top" | "bottom"
+```

package/metaData/components/load-more/api.md

@@ -0,0 +1,40 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|style|自定义样式|CSSProperties|-|
+|className|自定义类名|string|-|
+|disabled|是否禁用加载能力|boolean|-|
+|beforeReadyArea|组件加载但尚未启用状态下的内容|ReactNode|null|
+|loadingArea|加载中状态下的内容|ReactNode|"正在努力加载中..."|
+|noMoreArea|无更多数据状态下的内容|ReactNode|"没有更多数据了"|
+|prepareArea|准备加载状态下的内容|ReactNode|"上拉/点击加载更多"|
+|retryArea|加载重试状态下的内容|ReactNode|"加载失败，点击重试"|
+|defaultStatus|组件加载初始状态，传入 "before\-ready" 则先加载组件但不请求数据|"before\-ready" \| "prepare"|"prepare"|
+|status|当前状态，传入则受控|"before\-ready" \| "prepare" \| "loading" \| "nomore" \| "retry"|-|
+|getScrollContainer|待计算滚动容器|() =\> HTMLElement \| Window|() => window|
+|getOffsetNode|当多个 loadmore 在同一页面时，通过传入节点的 offsetHeight \+ offsetTop 代替 scrollHeight|() =\> HTMLElement \| Window|-|
+|trigger|触发loading的时机，当为click时，点击后将触发getData|"scroll" \| "click"|"scroll"|
+|threshold|滚动到离列表底部多远的位置触发getData，触发状态时机为'scroll'时有效|number|200|
+|getData|请求数据方法，可在异步任务结束后根据任务结果调用callback修改loadmore内部状态|(callback: (status: LoadMoreStatus) =\> void) =\> void|-|
+|throttle|节流粒度|number|0|
+|blockWhenLoading|是否在loading状态下不触发getData|boolean|true|
+|getDataAtFirst|刚加载好组件时是否自动先请求一次，trigger=scroll时有效|boolean|true|
+|getDataWhenNoScrollAtFirst|当 getDataAtFirst 值为 false 且数据不满一屏时是否触发一次请求，trigger=scroll时有效|boolean|false|
+|onStatusChange|状态改变时回调|(status: LoadMoreStatus, scene?: string) =\> void|-|
+|onClick|组件被点击时回调|(e: MouseEvent\<HTMLDivElement, MouseEvent\>) =\> void|-|
+|onEndReached|滚动到(底部 \- threshold)距离时触发|() =\> void|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|changeStatus|手动更改组件状态|(status: LoadMoreStatus, scene?: string) =\> void|
+|getDataWithEndReachCheck|判断是否滚动到底部并手动触发数据获取|() =\> void|
+
+> LoadMoreStatus
+
+```
+"before-ready" | "prepare" | "loading" | "nomore" | "retry"
+```

package/metaData/components/loading/api.md

@@ -0,0 +1,26 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|style|自定义样式|CSSProperties|-|
+|className|自定义类名|string|-|
+|color|主颜色，如果想使用 css 控制主颜色，可使用公共 mixin \`\.set\-loading\-color(@color)\`|string|-|
+|type|loading类型|"spin" \| "circle" \| "arc" \| "dot"|"dot"|
+|list|当类型为\`dot\`或\`spin\`时有效，定义内部各元素的透明度|number\[\]|-|
+|duration|一次loading周期的毫秒数|number|1000|
+|svgKey|区分不同loading组件间的\`\<def\>\`内容|string|-|
+|radius|圆圈半径，类型为\`circle\`或\`arc\`时可用|number|9|
+|stroke|圆圈描边宽度，类型为\`circle\`或\`arc\`或\`spin\`时可用|number|2|
+|filleted|边缘是否为圆角|boolean|true|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+
+> LoadingType
+
+```
+"spin" | "circle" | "arc" | "dot"
+```

package/metaData/components/masking/api.md

@@ -0,0 +1,85 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|contentAtCenter|弹窗内容是否居中|boolean|false|
+|className|自定义类名|string|-|
+|maskClass|自定义蒙层类名|string|-|
+|maskStyle|自定义蒙层样式|CSSProperties|-|
+|contentClass|自定义内容类名|string|-|
+|contentStyle|自定义内容样式|CSSProperties|-|
+|visible|是否展示菜单（受控）|boolean|必填|
+|close|关闭菜单方法|(e: MouseEvent\<HTMLElement, MouseEvent\>) =\> void|必填|
+|maskTransitionType|蒙层过渡动画类名|string|"fade"|
+|contentTransitionType|内容过渡动画类名|string|"fade"|
+|contentTransitionVarType|内容过渡动画类名变量标识|string|-|
+|children|菜单内部内容|ReactNode|-|
+|maskTransitionTimeout|蒙层动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|300|
+|contentTransitionTimeout|内容动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|300|
+|maskClosable|点击蒙层是否关闭菜单|boolean|true|
+|animatingClosable|执行进场动画时点击蒙层是否可关闭菜单|boolean|false|
+|mountOnEnter|是否在打开菜单时再加载内容|boolean|true|
+|unmountOnExit|是否在退出时卸载内容|boolean|true|
+|orientationDirection|transform方向，用于通过transform模拟横屏的情况|"top" \| "bottom" \| "left" \| "right"|"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
+
+|方法名|描述|类型|
+|----------|-------------|------|
+|open|打开模态弹窗|(config: MaskingProps) =\> \{ close: () =\> void; update: (newConfig: MaskingProps) =\> 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; \}|