@fjyueke/arco-mcp 1.0.0 → 1.0.1

package/metaData/components/nav-bar/api.md

@@ -0,0 +1,32 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|title|导航栏中间文字，带居中和溢出省略效果|ReactNode|-|
+|children|自定义导航栏主内容，当导航栏内容为Tabs等非居中文字样式时可用|ReactNode|-|
+|leftContent|导航栏左侧内容|ReactNode|返回按钮|
+|rightContent|导航栏右侧内容|ReactNode|-|
+|style|自定义样式，最外层元素的背景文字颜色可在此定义|CSSProperties|-|
+|className|内层自定义类名|string|-|
+|wrapClass|最外层元素自定义类名|string|-|
+|fixed|是否吸顶|boolean|-|
+|statusBarHeight|沉浸式状态栏高度|number|0|
+|hasBottomLine|是否有底边框|boolean|true|
+|onClickLeft|点击左侧内容回调|(e: MouseEvent\<Element, MouseEvent\>) =\> void|-|
+|onClickRight|点击右侧内容回调|(e: MouseEvent\<Element, MouseEvent\>) =\> void|-|
+|showOffset|展示nav\-bar的offset值，当scrollTop值小于该值时，将隐藏主内容和右侧内容，左侧内容保留|number|0|
+|onShowChange|设置showOffset后，当内容显示状态发生变化后触发|(show: boolean) =\> void|-|
+|placeholder|设置fixed=true时，导航栏原本的位置是否要占住|boolean|true|
+|extra|额外渲染元素，与inner平级|ReactNode|-|
+|getScrollContainer|自定义滚动元素，不传默认是window|() =\> HTMLElement \| Window|-|
+|getComputedStyleByScroll|根据滚动offset值设置自定义style，设置该属性后将监听滚动容器的滚动事件|(offset: number) =\> CSSProperties|-|
+|onScrollChange|滚动时回调，设置该属性后将监听滚动容器的滚动事件|(offset: number) =\> void|-|
+|ariaLabel|无障碍aria\-label属性|string|""|
+|ariaRole|无障碍role属性|string|"banner"|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|navBar|@deprecated|HTMLDivElement|
+|dom|最外层元素DOM|HTMLDivElement|

package/metaData/components/notice-bar/api.md

@@ -0,0 +1,26 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式，背景颜色和文字颜色可直接在这里指定\`background\`和\`color\`|CSSProperties|-|
+|children|通知内容文字，如需垂直滚动效果可传入一个Carousel|ReactNode|-|
+|leftContent|左侧内容|ReactNode|-|
+|rightContent|右侧内容|ReactNode|-|
+|marquee|通知文字处理方式，为\`overflow\`则文字超出容器长度时才滚动，为\`none\`则文字始终不滚动，为\`always\`则文字始终滚动|"overflow" \| "none" \| "always"|"overflow"|
+|closeable|是否可关闭|boolean|true|
+|closeIcon|自定义关闭图标|ReactNode|\<IconClose /\>|
+|wrapable|是否需要换行，当 marquee=none 且 wrapable=false 时，文字超出会有溢出省略(ellipsis)效果|boolean|true|
+|speed|文字滚动速度，单位是px/s|number|50|
+|delay|文字开始滚动之前的延迟(ms)|number|1000|
+|autoSetGradientStyle|是否根据\`style\`属性中自定义的背景色自动设置渐变背景色|boolean|true|
+|onClick|点击通知栏事件|(e: MouseEvent\<HTMLDivElement, MouseEvent\>) =\> void|-|
+|onClose|点击关闭按钮回调|(e: MouseEvent\<HTMLDivElement, MouseEvent\>) =\> void|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|close|手动关闭通知栏，即移除当前组件|() =\> void|
+|updateData|手动更新组件布局|() =\> void|

package/metaData/components/notify/api.md

@@ -0,0 +1,73 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|content|需要展示的内容|ReactNode|-|
+|type|通知类型|"success" \| "error" \| "warn" \| "info"|"info"|
+|visible|是否显示通知|boolean|false|
+|close|控制通知关闭的事件|() =\> void|-|
+|onClose|通知关闭时的回调函数|() =\> void|-|
+|getContainer|将通知放入某个模块|() =\> HTMLElement|-|
+|transitionDuration|动画的执行时间 (单位ms)|number|300|
+|duration|通知自动关闭时延 (单位ms) 设置为0时不会自动关闭|number|3000|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层dom元素|HTMLElement|
+|updateLayout|更新元素布局|() =\> void|
+
+> 方法/Methods
+
+|方法名|描述|类型|
+|----------|-------------|------|
+|info|展示常规通知|(config: string \| NotifyProps) =\> \{ update: (config: NotifyProps) =\> void; close: () =\> void \}|
+|success|展示成功通知|(config: string \| NotifyProps) =\> \{ update: (config: NotifyProps) =\> void; close: () =\> void \}|
+|error|展示错误的通知|(config: string \| NotifyProps) =\> \{ update: (config: NotifyProps) =\> void; close: () =\> void \}|
+|warn|展示警告的通知|(config: string \| NotifyProps) =\> \{ update: (config: NotifyProps) =\> void; close: () =\> void \}|
+
+> NotifyType
+
+```
+"success" | "error" | "warn" | "info"
+```
+
+> 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/pagination/api.md

@@ -0,0 +1,33 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|className|自定义类名|string|-|
+|style|自定义样式|CSSProperties|-|
+|type|分页器翻页区域样式类型，button表示按钮式分页器，text表示文本式分页器，none表示仅保留页码不含翻页区域|"button" \| "text" \| "none"|"button"|
+|icon|是否需要展示图标|ReactNode \| \[\.\.\.\]|false|
+|justify|翻页按钮水平位置，side表示两端对齐，center表示居中对齐|"center" \| "side"|"side"|
+|current|当前页码|number|1|
+|pageSize|每页条数|number|10|
+|total|数据总条数|number|0|
+|hideOnOnePage|只有一页时是否隐藏分页器|boolean|false|
+|nextFieldType|下一页样式，primary表示高亮|"default" \| "primary"|"default"|
+|prevFieldText|上一页文本|string|"上一页"|
+|nextFieldText|下一页文本|string|"下一页"|
+|renderPrevField|渲染前翻页按钮|(data: IPaginationDataParams) =\> ReactNode|-|
+|renderNextField|渲染后翻页按钮|(data: IPaginationDataParams) =\> ReactNode|-|
+|onChange|点击前/后翻页按钮时调用|(data: IPaginationDataParams) =\> void|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+
+> IPaginationDataParams
+
+|参数|描述|类型|
+|----------|-------------|------|
+|current|当前页|number|
+|pageSize|每页条数|number|
+|pageNum|总页数|number|

package/metaData/components/picker/api.md

@@ -0,0 +1,81 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|data|数据源，非级联时data数组的长度决定picker列数，级联时以cols决定 pick列数|PickerData\[\] \| PickerData\[\]\[\] \| ValueType\[\]\[\]|必填|
+|cascade|是否联动|boolean|true|
+|cols|列数(最大为5；cascade=true时才使用)|number|3|
+|rows|行数(一列可选项的行数)，必须是奇数，最小为3个|number|5|
+|disabled|是否不可用|boolean|false|
+|value|值, 格式是\[value1, value2, value3\], 对应数据源的相应级层value，如果不传默认选每一列的第一个值|ValueType\[\]|-|
+|onHide|点击遮罩层或取消、确定按钮的隐藏回调|(scene?: string) =\> void|-|
+|onChange|选中后的回调|(selectedValue: ValueType\[\]) =\> void|-|
+|onPickerChange|每列数据选择变化后的回调函数|(value: ValueType\[\], index: number, data: PickerData\[\]) =\> void|-|
+|itemStyle|每列样式|CSSProperties|-|
+|visible|是否展示选择器|boolean|false|
+|okText|弹窗确认已选值的文案|string|"确定"|
+|dismissText|弹窗取消的文案|string|"取消"|
+|onOk|点击选中时执行的回调|(value: ValueType\[\], data: PickerData\[\]) =\> void|-|
+|onDismiss|点击取消时执行的回调|() =\> void|-|
+|clickable|是否可通过点击操作选择内容|boolean|true|
+|hideEmptyCols|是否隐藏无数据的空列，常用于级联选择|boolean|false|
+|title|选择器标题|string|""|
+|maskClosable|点击蒙层是否关闭菜单|boolean|false|
+|touchToStop|是否通过长按停止滑动，传入数字 x 表示触摸超过 x 毫秒算长按，传 true 表示 x=100，长按事件与 click 事件互斥|number \| boolean|false|
+|gestureOutOfControl|是否禁用滚动容器手势判断，禁用后交给业务方自己判断|boolean|true|
+|renderLinkedContainer|将选择器的展现隐藏状态及选中值的展示与某个容器关联，传入后将同时渲染该容器和选择器组件，此时选择器组件的 visible 和 onHide 属性可不传，点击该容器会唤起选择器|(value: ValueType\[\], data: PickerData\[\]) =\> ReactNode|-|
+|renderExtraHeader|自定义头部扩展区域|() =\> ReactNode|-|
+|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值|
+|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|-|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|getCellMovingStatus|每一列的滑动状态|() =\> PickerCellMovingStatus\[\]|
+|updateLayout|手动更新元素布局|() =\> void|
+|getAllColumnValues|获取所有列的值|() =\> ValueType\[\]|
+|getColumnValue|获取第 n 列的值|(index: number) =\> ValueType|
+|scrollToCurrentIndex|直接跳到当前最近一行（调用时将中断滚动）|() =\> void|
+
+> PickerData
+
+|参数|描述|类型|
+|----------|-------------|------|
+|value|每一列展示的每项文案对应的值|ValueType|
+|label|每一列展示的文案|ReactNode|
+|children|级联状态下，该列对应的下一列数据|PickerData\[\]|
+
+> ValueType
+
+```
+string | number
+```
+
+> PickerCellMovingStatus
+
+```
+"normal" | "moving" | "scrolling"
+```

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

@@ -0,0 +1,49 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|data|数据源，非级联时data数组的长度决定picker列数，级联时以cols决定 pick列数|PickerData\[\] \| PickerData\[\]\[\] \| ValueType\[\]\[\]|必填|
+|cascade|是否联动|boolean|true|
+|cols|列数(最大为5；cascade=true时才使用)|number|3|
+|rows|行数(一列可选项的行数)，必须是奇数，最小为3个|number|5|
+|disabled|是否不可用|boolean|false|
+|value|值, 格式是\[value1, value2, value3\], 对应数据源的相应级层value|ValueType\[\]|-|
+|onPickerChange|每列数据选择变化后的回调函数|(value: ValueType\[\], index: number, data: PickerData\[\]) =\> void|-|
+|itemStyle|每列样式|CSSProperties|-|
+|className|自定义类名|string|-|
+|clickable|是否可通过点击操作选择内容|boolean|true|
+|hideEmptyCols|是否隐藏无数据的空列，常用于级联选择|boolean|false|
+|touchToStop|是否通过长按停止滑动，传入数字 x 表示触摸超过 x 毫秒算长按，传 true 表示 x=100，长按事件与 click 事件互斥|number \| boolean|false|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|最外层元素 DOM|HTMLDivElement|
+|getCellMovingStatus|每一列的滑动状态|() =\> PickerCellMovingStatus\[\]|
+|getAllColumnValues|获取所有列的值|() =\> ValueType\[\]|
+|getColumnValue|获取第 n 列的值|(index: number) =\> ValueType|
+|updateLayout|手动更新元素布局|() =\> void|
+|resetValue|重置选择器的值为传入的\`value\`值|() =\> void|
+|scrollToCurrentIndex|直接跳到当前最近一行（调用时将中断滚动）|() =\> void|
+|getAllColumnData|获取所有列的 data|() =\> PickerData\[\]|
+
+> PickerData
+
+|参数|描述|类型|
+|----------|-------------|------|
+|value|每一列展示的每项文案对应的值|ValueType|
+|label|每一列展示的文案|ReactNode|
+|children|级联状态下，该列对应的下一列数据|PickerData\[\]|
+
+> ValueType
+
+```
+string | number
+```
+
+> PickerCellMovingStatus
+
+```
+"normal" | "moving" | "scrolling"
+```

package/metaData/components/popover/api.md

@@ -0,0 +1,136 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|children|气泡载体，组件会监听其变化以重新计算布局，建议用 useMemo 包裹|ReactNode|-|
+|innerPopoverClassName|自定义气泡类名|string|''|
+|visible|是否显示气泡，受控模式|boolean|-|
+|content|气泡内容，组件会监听其变化以重新计算布局，建议用 useMemo 包裹|ReactNode|null|
+|direction|气泡展示的位置|"topLeft" \| "topCenter" \| "topRight" \| "bottomLeft" \| "bottomCenter" \| "bottomRight"|'topRight'|
+|duration|自动关闭场景下的停留时长，单位毫秒，为0则表示不自动关闭|number|0|
+|transitionTimeout|动画时长，单位毫秒|number \| \{ appear?: number; enter?: number; exit?: number; \}|300|
+|minWidth|气泡最小宽度|string|'10px'|
+|maxWidth|气泡最大宽度|string|'90vw'|
+|transitionName|气泡过渡动画类名，修改类名需自行实现动画|string|'fade'|
+|verticalOffset|气泡垂直方向上相对于子元素的偏移量，单位为px|number|10|
+|horizontalOffset|气泡水平方向上相对于子元素的偏移量，单位为px|number|8|
+|useAutoDirection|气泡边界自适应，开启时会在气泡左右边界留出安全距离，气泡与视窗上下边界小于安全距离时改变气泡的垂直方向，使其在视窗中漏出|boolean \| \{ horizontal: boolean; vertical: boolean; \}|true|
+|edgeOffset|气泡距离边界的安全距离，单位为px|number \| EdgeOffset|14|
+|verticalScrollThrottle|滚动容器的滚动事件节流粒度，单位ms|number|100|
+|arrowWidth|气泡尖角大小，单位为px|number|9|
+|preventBodyClick|气泡出现后，是否屏蔽非内部元素的点击事件，点击非内部元素后只做隐藏气泡操作|boolean|false|
+|clickOtherToClose|点击非子元素和气泡元素是否关闭气泡|boolean|true|
+|clickSelfToClose|点击气泡和子元素是否关闭气泡|boolean|true|
+|touchOtherToClose|触碰非子元素和气泡元素是否关闭气泡|boolean|false|
+|touchSelfToClose|触碰气泡和子元素是否关闭气泡|boolean|false|
+|touchToClose|触碰页面是否关闭气泡，是touchOtherToClose和touchSelfToClose的默认值|boolean|false|
+|theme|气泡的主题，black主题是黑底白字，white主题是白底黑字|"black" \| "white"|'black'|
+|needShadow|气泡内容是否需要阴影|boolean|false|
+|bordered|气泡是否有border|boolean|白色主题默认有边框，黑色主题没有|
+|defaultVisible|气泡是否可见的默认值，非受控模式|boolean|false|
+|showCloseIcon|是否展示关闭按钮|boolean|false|
+|textSuffix|文字气泡后置元素，如操作按钮等|ReactNode|null|
+|mode|气泡挂载位置，follow模式挂载在当前子元素下，global模式挂载在body上|"follow" \| "global"|'follow'|
+|showMask|是否展示蒙层|boolean|false|
+|maskTransitionTimeout|蒙层动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|{ enter: 450, exit: 240 }|
+|renderArrow|自定义箭头渲染|(options: \{ arrowWidth?: number; arrowLeft: number; direction: Direction; \}) =\> ReactNode|-|
+|onChange|状态发生改变的回调事件|(visible: boolean) =\> void|() => void|
+|onClickCloseIcon|点击关闭icon的回调|() =\> void|() => void|
+|onClickTextSuffix|点击文字气泡后置元素回调|() =\> void|() => void|
+|onClickMask|点击蒙层回调|() =\> void|() => void|
+|getVerticalScrollContainer|获取页面垂直方向的滚动容器|() =\> HTMLElement|() => document|
+|className|自定义类名|string|""|
+|style|自定义样式|CSSProperties|{}|
+
+> 引用/Refs
+
+|参数|描述|类型|
+|----------|-------------|------|
+|child|气泡包裹子元素dom|HTMLDivElement|
+|innerPopover|气泡组件 ref|PopoverInnerRef|
+|innerPopoverDom|气泡元素dom|HTMLDivElement|
+|updatePosition|手动更新气泡的位置|() =\> void|
+|dom|组件外层dom元素|HTMLDivElement|
+
+> Popover.Menu
+
+气泡菜单
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|menu|菜单项列表|(string \| PopoverMenuItem)\[\]|必填|
+|menuLayout|菜单排列顺序，默认为竖向菜单，支持横向菜单和竖向菜单，横向菜单一行最多可放4个菜单|"vertical" \| "horizontal"|'vertical'|
+|useClickStatus|菜单项是否有点击态|boolean|false|
+|clickStatusDuration|菜单项点击态持续时长，单位毫秒|number|300|
+|onSelect|选择可用菜单项的回调|(value: string, item: string \| PopoverMenuItem) =\> void|() => {}|
+|onClickMenuItem|点击所有菜单项回调|(value: string, item: string \| PopoverMenuItem) =\> void|必填|
+|children|气泡载体，组件会监听其变化以重新计算布局，建议用 useMemo 包裹|ReactNode|-|
+|innerPopoverClassName|自定义气泡类名|string|''|
+|visible|是否显示气泡，受控模式|boolean|-|
+|content|气泡内容，组件会监听其变化以重新计算布局，建议用 useMemo 包裹|ReactNode|null|
+|direction|气泡展示的位置|"topLeft" \| "topCenter" \| "topRight" \| "bottomLeft" \| "bottomCenter" \| "bottomRight"|'topRight'|
+|duration|自动关闭场景下的停留时长，单位毫秒，为0则表示不自动关闭|number|0|
+|transitionTimeout|动画时长，单位毫秒|number \| \{ appear?: number; enter?: number; exit?: number; \}|300|
+|minWidth|气泡最小宽度|string|'10px'|
+|maxWidth|气泡最大宽度|string|'90vw'|
+|transitionName|气泡过渡动画类名，修改类名需自行实现动画|string|'fade'|
+|verticalOffset|气泡垂直方向上相对于子元素的偏移量，单位为px|number|10|
+|horizontalOffset|气泡水平方向上相对于子元素的偏移量，单位为px|number|8|
+|useAutoDirection|气泡边界自适应，开启时会在气泡左右边界留出安全距离，气泡与视窗上下边界小于安全距离时改变气泡的垂直方向，使其在视窗中漏出|boolean \| \{ horizontal: boolean; vertical: boolean; \}|true|
+|edgeOffset|气泡距离边界的安全距离，单位为px|number \| EdgeOffset|14|
+|verticalScrollThrottle|滚动容器的滚动事件节流粒度，单位ms|number|100|
+|arrowWidth|气泡尖角大小，单位为px|number|9|
+|preventBodyClick|气泡出现后，是否屏蔽非内部元素的点击事件，点击非内部元素后只做隐藏气泡操作|boolean|false|
+|clickOtherToClose|点击非子元素和气泡元素是否关闭气泡|boolean|true|
+|clickSelfToClose|点击气泡和子元素是否关闭气泡|boolean|true|
+|touchOtherToClose|触碰非子元素和气泡元素是否关闭气泡|boolean|false|
+|touchSelfToClose|触碰气泡和子元素是否关闭气泡|boolean|false|
+|touchToClose|触碰页面是否关闭气泡，是touchOtherToClose和touchSelfToClose的默认值|boolean|false|
+|theme|气泡的主题，black主题是黑底白字，white主题是白底黑字|"black" \| "white"|'black'|
+|needShadow|气泡内容是否需要阴影|boolean|false|
+|bordered|气泡是否有border|boolean|白色主题默认有边框，黑色主题没有|
+|defaultVisible|气泡是否可见的默认值，非受控模式|boolean|false|
+|showCloseIcon|是否展示关闭按钮|boolean|false|
+|textSuffix|文字气泡后置元素，如操作按钮等|ReactNode|null|
+|mode|气泡挂载位置，follow模式挂载在当前子元素下，global模式挂载在body上|"follow" \| "global"|'follow'|
+|showMask|是否展示蒙层|boolean|false|
+|maskTransitionTimeout|蒙层动画时长|number \| \{ appear?: number; enter?: number; exit?: number; \}|{ enter: 450, exit: 240 }|
+|renderArrow|自定义箭头渲染|(options: \{ arrowWidth?: number; arrowLeft: number; direction: Direction; \}) =\> ReactNode|-|
+|onChange|状态发生改变的回调事件|(visible: boolean) =\> void|() => void|
+|onClickCloseIcon|点击关闭icon的回调|() =\> void|() => void|
+|onClickTextSuffix|点击文字气泡后置元素回调|() =\> void|() => void|
+|onClickMask|点击蒙层回调|() =\> void|() => void|
+|getVerticalScrollContainer|获取页面垂直方向的滚动容器|() =\> HTMLElement|() => document|
+|className|自定义类名|string|""|
+|style|自定义样式|CSSProperties|{}|
+
+> Direction
+
+```
+"topLeft" | "topCenter" | "topRight" | "bottomLeft" | "bottomCenter" | "bottomRight"
+```
+
+> EdgeOffset
+
+|参数|描述|类型|
+|----------|-------------|------|
+|top|上|number|
+|right|右|number|
+|bottom|下|number|
+|left|左|number|
+
+> PopoverInnerRef
+
+|参数|描述|类型|
+|----------|-------------|------|
+|dom|组件容器dom|HTMLDivElement|
+|content|-|HTMLDivElement|
+
+> PopoverMenuItem
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|text|菜单项文本|ReactNode|必填|
+|value|菜单项值|string|text|
+|icon|菜单项的icon组件|ReactNode|null|
+|disabled|是否禁用菜单项|boolean|false|

package/metaData/components/popup/api.md

@@ -0,0 +1,93 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|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}\`|
+|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
+
+|方法名|描述|类型|
+|----------|-------------|------|
+|open|打开弹出层|(config: PopupProps) =\> \{ close: () =\> void; update: (newConfig: PopupProps) =\> void; \}|
+
+> DirectionType
+
+```
+"left" | "right" | "top" | "bottom"
+```
+
+> 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/popup-swiper/api.md

@@ -0,0 +1,100 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|percentToClose|滑动超过内容的百分之多少时关闭弹窗，范围为\[0, 1\]，如果该属性和\`distanceToClose\`属性均设置，则实际计算结果更大的生效|number|0.3|
+|distanceToClose|滑动超过多少px时关闭弹窗，如果该属性和\`percentToClose\`属性均设置，则实际计算结果更大的生效|number|10|
+|speedToClose|手指从按下到抬起之间的滑动速度超过多少时关闭弹窗(单位为px/s)，与滑动关闭距离阈值同时设置时，满足其中一个即生效|number|200|
+|allowSwipeDirections|自定义可手势滑动退出的方向，可指定多个方向|DirectionType\[\]|direction 属性指定的方向性|
+|exitDirection|固定弹窗退出方向，默认跟随手势滑动方向|"left" \| "right" \| "top" \| "bottom"|-|
+|onTouchStart|内容面板 touchstart 事件，返回true时表示阻止本组件内部处理事件|(e: TouchEvent) =\> boolean \| void|-|
+|onTouchMove|内容面板 touchmove 事件，返回true时表示阻止本组件内部处理事件|(e: TouchEvent, prevented: boolean, direction: "x" \| "y") =\> boolean \| void|-|
+|onTouchEnd|内容面板 touchend / touchcancel 事件，返回true时表示阻止本组件内部处理事件|(e: TouchEvent) =\> boolean \| void|-|
+|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}\`|
+|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|-|
+|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: string \| PopupSwiperProps) =\> \{ close: () =\> void; update: (newConfig: PopupSwiperProps) =\> void; \}|
+
+> DirectionType
+
+```
+"left" | "right" | "top" | "bottom"
+```
+
+> 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/portal/api.md

@@ -0,0 +1,6 @@
+> 属性/Props
+
+|参数|描述|类型|默认值|
+|----------|-------------|------|------|
+|children|被挂载的内容|ReactNode|-|
+|getContainer|容器获取函数|() =\> HTMLElement|() => document.body|