blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

docs: remove v3 version tag in v4 document (#11616)

Browse Source
This commit is contained in:
neverland 2023-02-25 19:55:08 +08:00 committed by GitHub
parent cf1de18dde
commit a9864d5071
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
85 changed files with 406 additions and 406 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
packages/vant/src/action-bar/README.md
View File

@ -90,7 +90,7 @@ Use `badge` prop to show badge in icon.
| Attribute | Description | Type | Default |
| --- | --- | --- | --- |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` |
| placeholder `v3.5.1` | Whether to generate a placeholder element | _boolean_ | `false` |
| placeholder | Whether to generate a placeholder element | _boolean_ | `false` |
### ActionBarIcon Props
@ -100,10 +100,10 @@ Use `badge` prop to show badge in icon.
| icon | Icon | _string_ | - |
| color | Icon color | _string_ | `#323233` |
| icon-class | Icon class name | _string \| Array \| object_ | `''` |
| icon-prefix `v3.0.17` | Icon className prefix | _string_ | `van-icon` |
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
| dot | Whether to show red dot | _boolean_ | - |
| badge | Content of the badge | _number \| string_ | - |
| badge-props `v3.2.8` | Props of Badge, see [Badge - props](#/en-US/badge#props) | _BadgeProps_ | - |
| badge-props | Props of Badge, see [Badge - props](#/en-US/badge#props) | _BadgeProps_ | - |
| url | Link URL | _string_ | - |
| to | Target route of the link, same as to of vue-router | _string \| object_ | - |
| replace | If true, the navigation will not leave a history record | _boolean_ | `false` |

6
packages/vant/src/action-bar/README.zh-CN.md
View File

@ -94,7 +94,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `true` |
| placeholder `v3.5.1` | 是否在标签位置生成一个等高的占位元素 | _boolean_ | `false` |
| placeholder | 是否在标签位置生成一个等高的占位元素 | _boolean_ | `false` |
### ActionBarIcon Props
@ -104,10 +104,10 @@ export default {
| icon | 图标 | _string_ | - |
| color | 图标颜色 | _string_ | `#323233` |
| icon-class | 图标额外类名 | _string \| Array \| object_ | - |
| icon-prefix `v3.0.17` | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| icon-prefix | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| dot | 是否显示图标右上角小红点 | _boolean_ | `false` |
| badge | 图标右上角徽标的内容 | _number \| string_ | - |
| badge-props `v3.2.8` | 自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props) | _BadgeProps_ | - |
| badge-props | 自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props) | _BadgeProps_ | - |
| url | 点击后跳转的链接地址 | _string_ | - |
| to | 点击后跳转的目标路由对象，等同于 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - |
| replace | 是否在跳转时替换当前页面历史 | _boolean_ | `false` |

6
packages/vant/src/action-sheet/README.md
View File

@ -191,7 +191,7 @@ export default {
| close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` |
| teleport | Specifies a target element where ActionSheet will be mounted | _string \| Element_ | - |
| before-close `v3.1.4` | Callback function before close | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| before-close | Callback function before close | _(action: string) => boolean \| Promise\<boolean\>_ | - |
### Data Structure of ActionSheetAction
@ -223,8 +223,8 @@ export default {
| --- | --- | --- |
| default | Custom content |
| description | Custom description above the options |
| cancel `v3.0.10` | Custom the content of cancel button |
| action `v3.4.0` | Custom the content of action | _{ action: ActionSheetAction, index: number }_ |
| cancel | Custom the content of cancel button |
| action | Custom the content of action | _{ action: ActionSheetAction, index: number }_ |
### Types

6
packages/vant/src/action-sheet/README.zh-CN.md
View File

@ -201,7 +201,7 @@ export default {
| close-on-click-overlay | 是否在点击遮罩层后关闭 | _boolean_ | `true` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `true` |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
| before-close `v3.1.4` | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| before-close | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(action: string) => boolean \| Promise\<boolean\>_ | - |
### Action 数据结构
@ -235,8 +235,8 @@ export default {
| --- | --- | --- |
| default | 自定义面板的展示内容 | - |
| description | 自定义描述文案 | - |
| cancel `v3.0.10` | 自定义取消按钮内容 | - |
| action `v3.4.0` | 自定义选项内容 | _{ action: ActionSheetAction, index: number }_ |
| cancel | 自定义取消按钮内容 | - |
| action | 自定义选项内容 | _{ action: ActionSheetAction, index: number }_ |
### 类型定义

12
packages/vant/src/address-list/README.md
View File

@ -114,12 +114,12 @@ export default {
### Slots
| Name | Description | SlotProps |
| ------------ | ------------------------------ | --------------- |
| default | Custom content after list | - |
| top | Custom content before list | - |
| item-bottom | Custom content after list item | _item: Address_ |
| tag `v3.0.9` | Custom tag of list item | _item: Address_ |
| Name | Description | SlotProps |
| ----------- | ------------------------------ | --------------- |
| default | Custom content after list | - |
| top | Custom content before list | - |
| item-bottom | Custom content after list item | _item: Address_ |
| tag | Custom tag of list item | _item: Address_ |
### Types

12
packages/vant/src/address-list/README.zh-CN.md
View File

@ -114,12 +114,12 @@ export default {
### Slots
| 名称 | 说明 | 参数 |
| ------------ | -------------------- | -------------------------- |
| default | 在列表下方插入内容 | - |
| top | 在顶部插入内容 | - |
| item-bottom | 在列表项底部插入内容 | _item: AddressListAddress_ |
| tag `v3.0.9` | 自定义列表项标签内容 | _item: AddressListAddress_ |
| 名称 | 说明 | 参数 |
| ----------- | -------------------- | -------------------------- |
| default | 在列表下方插入内容 | - |
| top | 在顶部插入内容 | - |
| item-bottom | 在列表项底部插入内容 | _item: AddressListAddress_ |
| tag | 自定义列表项标签内容 | _item: AddressListAddress_ |
### 类型定义

16
packages/vant/src/area/README.zh-CN.md
View File

@ -147,14 +147,14 @@ export default {
### Slots
| 名称 | 说明 | 参数 |
| ---------------- | ---------------------- | ---- |
| toolbar `v3.1.2` | 自定义整个顶部栏的内容 | - |
| title | 自定义标题内容 | - |
| confirm `v3.1.2` | 自定义确认按钮内容 | - |
| cancel `v3.1.2` | 自定义取消按钮内容 | - |
| columns-top | 自定义选项上方内容 | - |
| columns-bottom | 自定义选项下方内容 | - |
| 名称 | 说明 | 参数 |
| -------------- | ---------------------- | ---- |
| toolbar | 自定义整个顶部栏的内容 | - |
| title | 自定义标题内容 | - |
| confirm | 自定义确认按钮内容 | - |
| cancel | 自定义取消按钮内容 | - |
| columns-top | 自定义选项上方内容 | - |
| columns-bottom | 自定义选项下方内容 | - |
### 方法

6
packages/vant/src/badge/README.md
View File

@ -139,9 +139,9 @@ Use `position` prop to set the position of badge.
| color | Background color | _string_ | `#ee0a24` |
| dot | Whether to show dot | _boolean_ | `false` |
| max | Max value, show `{max}+` when exceed, only works when content is number | _number \| string_ | - |
| offset `v3.0.5` | Offset of badge dot, the two items of the array correspond to the horizontal and vertical offsets | _[number \| string, number \| string]_ | - |
| show-zero `v3.0.10` | Whether to show badge when content is zero | _boolean_ | `true` |
| position `v3.2.7` | Badge position, can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| offset | Offset of badge dot, the two items of the array correspond to the horizontal and vertical offsets | _[number \| string, number \| string]_ | - |
| show-zero | Whether to show badge when content is zero | _boolean_ | `true` |
| position | Badge position, can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
### Slots

6
packages/vant/src/badge/README.zh-CN.md
View File

@ -147,9 +147,9 @@ app.use(Badge);
| color | 徽标背景颜色 | _string_ | `#ee0a24` |
| dot | 是否展示为小红点 | _boolean_ | `false` |
| max | 最大值，超过最大值会显示 `{max}+`，仅当 content 为数字时有效 | _number \| string_ | - |
| offset `v3.0.5` | 设置徽标的偏移量，数组的两项分别对应水平向右和垂直向下方向的偏移量，默认单位为 `px` | _[number \| string, number \| string]_ | - |
| show-zero `v3.0.10` | 当 content 为数字 0 或字符串 '0' 时，是否展示徽标 | _boolean_ | `true` |
| position `v3.2.7` | 徽标位置，可选值为 `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| offset | 设置徽标的偏移量，数组的两项分别对应水平向右和垂直向下方向的偏移量，默认单位为 `px` | _[number \| string, number \| string]_ | - |
| show-zero | 当 content 为数字 0 或字符串 '0' 时，是否展示徽标 | _boolean_ | `true` |
| position | 徽标位置，可选值为 `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
### Slots

10
packages/vant/src/button/README.md
View File

@ -146,11 +146,11 @@ app.use(Button);
### Slots
| Name | Description |
| -------------- | ------------------- |
| default | Default slot |
| icon `v3.0.18` | Custom icon |
| loading | Custom loading icon |
| Name | Description |
| ------- | ------------------- |
| default | Default slot |
| icon | Custom icon |
| loading | Custom loading icon |
### Types

10
packages/vant/src/button/README.zh-CN.md
View File

@ -169,11 +169,11 @@ app.use(Button);
### Slots
| 名称 | 说明 |
| -------------- | -------------- |
| default | 按钮内容 |
| icon `v3.0.18` | 自定义图标 |
| loading | 自定义加载图标 |
| 名称 | 说明 |
| ------- | -------------- |
| default | 按钮内容 |
| icon | 自定义图标 |
| loading | 自定义加载图标 |
### 类型定义

10
packages/vant/src/calendar/README.md
View File

@ -327,19 +327,19 @@ Following props are supported when the type is multiple
| unselect | Emitted when unselect date when type is multiple | _value: Date_ |
| month-show | Emitted when a month enters the visible area | _value: { date: Date, title: string }_ |
| over-range | Emitted when exceeded max range | - |
| click-subtitle `v3.1.3` | Emitted when clicking the subtitle | _event: MouseEvent_ |
| click-subtitle | Emitted when clicking the subtitle | _event: MouseEvent_ |
### Slots
| Name | Description | SlotProps |
| --- | --- | --- |
| title | Custom title | - |
| subtitle `v3.1.3` | Custom subtitle | _{ text: string, date?: Date }_ |
| subtitle | Custom subtitle | _{ text: string, date?: Date }_ |
| month-title `v4.0.9` | Custom title of every month | _{ text: string, date: Date }_ |
| footer | Custom footer | - |
| confirm-text `v3.2.6` | Custom confirm text | _{ disabled: boolean }_ |
| top-info `v3.0.17` | Custom top info of day | _day: Day_ |
| bottom-info `v3.0.17` | Custom bottom info of day | _day: Day_ |
| confirm-text | Custom confirm text | _{ disabled: boolean }_ |
| top-info | Custom top info of day | _day: Day_ |
| bottom-info | Custom bottom info of day | _day: Day_ |
### Methods

10
packages/vant/src/calendar/README.zh-CN.md
View File

@ -333,19 +333,19 @@ export default {
| unselect | 当日历组件的 `type` 为 `multiple` 时，取消选中日期时触发 | _value: Date_ |
| month-show | 当某个月份进入可视区域时触发 | _{ date: Date, title: string }_ |
| over-range | 范围选择超过最多可选天数时触发 | - |
| click-subtitle `v3.1.3` | 点击日历副标题时触发 | _event: MouseEvent_ |
| click-subtitle | 点击日历副标题时触发 | _event: MouseEvent_ |
### Slots
| 名称 | 说明 | 参数 |
| --- | --- | --- |
| title | 自定义标题 | - |
| subtitle `v3.1.3` | 自定义日历副标题 | _{ text: string, date?: Date }_ |
| subtitle | 自定义日历副标题 | _{ text: string, date?: Date }_ |
| month-title `v4.0.9` | 自定义每个月份的小标题 | _{ text: string, date: Date }_ |
| footer | 自定义底部区域内容 | - |
| confirm-text `v3.2.6` | 自定义确认按钮的内容 | _{ disabled: boolean }_ |
| top-info `v3.0.17` | 自定义日期上方的提示信息 | _day: Day_ |
| bottom-info `v3.0.17` | 自定义日期下方的提示信息 | _day: Day_ |
| confirm-text | 自定义确认按钮的内容 | _{ disabled: boolean }_ |
| top-info | 自定义日期上方的提示信息 | _day: Day_ |
| bottom-info | 自定义日期下方的提示信息 | _day: Day_ |
### 方法

30
packages/vant/src/cascader/README.md
View File

@ -253,22 +253,22 @@ export default {
| options | Options | _CascaderOption[]_ | `[]` |
| placeholder | Placeholder of unselected tab | _string_ | `Select` |
| active-color | Active color | _string_ | `#1989fa` |
| swipeable `v3.0.11` | Whether to enable gestures to slide left and right | _boolean_ | `false` |
| swipeable | Whether to enable gestures to slide left and right | _boolean_ | `false` |
| closeable | Whether to show close icon | _boolean_ | `true` |
| show-header `v3.4.2` | Whether to show header | _boolean_ | `true` |
| close-icon `v3.0.10` | Close icon name | _string_ | `cross` |
| field-names `v3.0.4` | Custom the fields of options | _CascaderFieldNames_ | `{ text: 'text', value: 'value', children: 'children' }` |
| show-header | Whether to show header | _boolean_ | `true` |
| close-icon | Close icon name | _string_ | `cross` |
| field-names | Custom the fields of options | _CascaderFieldNames_ | `{ text: 'text', value: 'value', children: 'children' }` |
### Data Structure of CascaderOption
| Key | Description | Type |
| ------------------ | ------------------------- | --------------------------- |
| text | Option text | _string_ |
| value | Option value | _string \| number_ |
| color `v3.1.0` | Text color | _string_ |
| children | Cascade children | _CascaderOption[]_ |
| disabled `v3.1.2` | Whether to disable option | _boolean_ |
| className `v3.1.0` | className for the option | _string \| Array \| object_ |
| Key | Description | Type |
| --------- | ------------------------- | --------------------------- |
| text | Option text | _string_ |
| value | Option value | _string \| number_ |
| color | Text color | _string_ |
| children | Cascade children | _CascaderOption[]_ |
| disabled | Whether to disable option | _boolean_ |
| className | className for the option | _string \| Array \| object_ |
### Events
@ -284,9 +284,9 @@ export default {
| Name | Description | SlotProps |
| --- | --- | --- |
| title | Custom title | - |
| option `v3.1.4` | Custom option text | _{ option: CascaderOption, selected: boolean }_ |
| options-top `v3.2.7` | Custom the content above the options | _{ tabIndex: number }_ |
| options-bottom `v3.2.8` | Custom the content below the options | _{ tabIndex: number }_ |
| option | Custom option text | _{ option: CascaderOption, selected: boolean }_ |
| options-top | Custom the content above the options | _{ tabIndex: number }_ |
| options-bottom | Custom the content below the options | _{ tabIndex: number }_ |
### Types

30
packages/vant/src/cascader/README.zh-CN.md
View File

@ -325,24 +325,24 @@ export default {
| options | 可选项数据源 | _CascaderOption[]_ | `[]` |
| placeholder | 未选中时的提示文案 | _string_ | `请选择` |
| active-color | 选中状态的高亮颜色 | _string_ | `#1989fa` |
| swipeable `v3.0.11` | 是否开启手势左右滑动切换 | _boolean_ | `false` |
| swipeable | 是否开启手势左右滑动切换 | _boolean_ | `false` |
| closeable | 是否显示关闭图标 | _boolean_ | `true` |
| show-header `v3.4.2` | 是否展示标题栏 | _boolean_ | `true` |
| close-icon `v3.0.10` | 关闭图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | `cross` |
| field-names `v3.0.4` | 自定义 `options` 结构中的字段 | _CascaderFieldNames_ | `{ text: 'text', value: 'value', children: 'children' }` |
| show-header | 是否展示标题栏 | _boolean_ | `true` |
| close-icon | 关闭图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | `cross` |
| field-names | 自定义 `options` 结构中的字段 | _CascaderFieldNames_ | `{ text: 'text', value: 'value', children: 'children' }` |
### CascaderOption 数据结构
`options` 属性是一个由对象构成的数组，数组中的每个对象配置一个可选项，对象可以包含以下值：
| 键名 | 说明 | 类型 |
| ------------------ | ------------------------ | --------------------------- |
| text | 选项文字（必填） | _string_ |
| value | 选项对应的值（必填） | _string \| number_ |
| color `v3.1.0` | 选项文字颜色 | _string_ |
| children | 子选项列表 | _CascaderOption[]_ |
| disabled `v3.1.2` | 是否禁用选项 | _boolean_ |
| className `v3.1.0` | 为对应列添加额外的 class | _string \| Array \| object_ |
| 键名 | 说明 | 类型 |
| --------- | ------------------------ | --------------------------- |
| text | 选项文字（必填） | _string_ |
| value | 选项对应的值（必填） | _string \| number_ |
| color | 选项文字颜色 | _string_ |
| children | 子选项列表 | _CascaderOption[]_ |
| disabled | 是否禁用选项 | _boolean_ |
| className | 为对应列添加额外的 class | _string \| Array \| object_ |
### Events
@ -358,9 +358,9 @@ export default {
| 名称 | 说明 | 参数 |
| --- | --- | --- |
| title | 自定义顶部标题 | - |
| option `v3.1.4` | 自定义选项文字 | _{ option: CascaderOption, selected: boolean }_ |
| options-top `v3.2.7` | 自定义选项上方的内容 | _{ tabIndex: number }_ |
| options-bottom `v3.2.8` | 自定义选项下方的内容 | _{ tabIndex: number }_ |
| option | 自定义选项文字 | _{ option: CascaderOption, selected: boolean }_ |
| options-top | 自定义选项上方的内容 | _{ tabIndex: number }_ |
| options-bottom | 自定义选项下方的内容 | _{ tabIndex: number }_ |
### 类型定义

26
packages/vant/src/cell/README.md
View File

@ -130,11 +130,11 @@ app.use(CellGroup);
### CellGroup Props
| Attribute | Description | Type | Default |
| -------------- | ---------------------------- | --------- | ------- |
| title | Group title | _string_ | - |
| inset `v3.1.0` | Whether to be inset grouped | _boolean_ | `false` |
| border | Whether to show outer border | _boolean_ | `true` |
| Attribute | Description | Type | Default |
| --------- | ---------------------------- | --------- | ------- |
| title | Group title | _string_ | - |
| inset | Whether to be inset grouped | _boolean_ | `false` |
| border | Whether to show outer border | _boolean_ | `true` |
### Cell Props
@ -176,14 +176,14 @@ app.use(CellGroup);
### Cell Slots
| Name | Description |
| -------------- | --------------------------------- |
| title | Custom title |
| value `v3.1.1` | Custom value |
| label | Custom label |
| icon | Custom left icon |
| right-icon | Custom right icon |
| extra | Custom extra content on the right |
| Name | Description |
| ---------- | --------------------------------- |
| title | Custom title |
| value | Custom value |
| label | Custom label |
| icon | Custom left icon |
| right-icon | Custom right icon |
| extra | Custom extra content on the right |
### Types

26
packages/vant/src/cell/README.zh-CN.md
View File

@ -135,11 +135,11 @@ app.use(CellGroup);
### CellGroup Props
| 参数 | 说明 | 类型 | 默认值 |
| -------------- | ---------------------- | --------- | ------- |
| title | 分组标题 | _string_ | `-` |
| inset `v3.1.0` | 是否展示为圆角卡片风格 | _boolean_ | `false` |
| border | 是否显示外边框 | _boolean_ | `true` |
| 参数 | 说明 | 类型 | 默认值 |
| ------ | ---------------------- | --------- | ------- |
| title | 分组标题 | _string_ | `-` |
| inset | 是否展示为圆角卡片风格 | _boolean_ | `false` |
| border | 是否显示外边框 | _boolean_ | `true` |
### Cell Props
@ -181,14 +181,14 @@ app.use(CellGroup);
### Cell Slots
| 名称 | 说明 |
| -------------- | ---------------------------- |
| title | 自定义左侧标题 |
| value `v3.1.1` | 自定义右侧内容 |
| label | 自定义标题下方的描述信息 |
| icon | 自定义左侧图标 |
| right-icon | 自定义右侧图标 |
| extra | 自定义单元格最右侧的额外内容 |
| 名称 | 说明 |
| ---------- | ---------------------------- |
| title | 自定义左侧标题 |
| value | 自定义右侧内容 |
| label | 自定义标题下方的描述信息 |
| icon | 自定义左侧图标 |
| right-icon | 自定义右侧图标 |
| extra | 自定义单元格最右侧的额外内容 |
### 类型定义

2
packages/vant/src/circle/README.md
View File

@ -159,7 +159,7 @@ export default {
| stroke-width | Stroke width | _number \| string_ | `40` |
| stroke-linecap | Stroke linecap, can be set to `square` `butt` | _string_ | `round` |
| clockwise | Whether to be clockwise | _boolean_ | `true` |
| start-position `v3.2.1` | Progress start position, can be set to `left`、`right`、`bottom` | _CircleStartPosition_ | `top` |
| start-position | Progress start position, can be set to `left`、`right`、`bottom` | _CircleStartPosition_ | `top` |
### Slots

2
packages/vant/src/circle/README.zh-CN.md
View File

@ -173,7 +173,7 @@ export default {
| stroke-width | 进度条宽度 | _number \| string_ | `40` |
| stroke-linecap | 进度条端点的形状，可选值为 `square` `butt` | _string_ | `round` |
| clockwise | 是否顺时针增加 | _boolean_ | `true` |
| start-position `v3.2.1` | 进度起始位置，可选值为 `left`、`right`、`bottom` | _CircleStartPosition_ | `top` |
| start-position | 进度起始位置，可选值为 `left`、`right`、`bottom` | _CircleStartPosition_ | `top` |
### Slots

2
packages/vant/src/col/README.md
View File

@ -91,7 +91,7 @@ Set grid spacing using `gutter` attribute. The default value is 0.
| tag | Custom element tag | _string_ | `div` |
| justify | Flex main axis, can be set to end/center/space-around/space-between | _string_ | `start` |
| align | Flex cross axis, be set to center/bottom | _string_ | `top` |
| wrap `v3.0.11` | Whether to wrap | _boolean_ | `true` |
| wrap | Whether to wrap | _boolean_ | `true` |
### Col Props

2
packages/vant/src/col/README.zh-CN.md
View File

@ -96,7 +96,7 @@ Layout 组件提供了 `24列栅格`，通过在 `Col` 上添加 `span` 属性
| tag | 自定义元素标签 | _string_ | `div` |
| justify | 主轴对齐方式，可选值为 `end` `center` <br> `space-around` `space-between` | _string_ | `start` |
| align | 交叉轴对齐方式，可选值为 `center` `bottom` | _string_ | `top` |
| wrap `v3.0.11` | 是否自动换行 | _boolean_ | `true` |
| wrap | 是否自动换行 | _boolean_ | `true` |
### Col Props

22
packages/vant/src/collapse/README.md
View File

@ -178,9 +178,9 @@ export default {
| label | Description below the title | _string_ | - |
| border | Whether to show inner border | _boolean_ | `true` |
| disabled | Whether to disabled collapse | _boolean_ | `false` |
| readonly `v3.0.12` | Whether to be readonly | _boolean_ | `false` |
| readonly | Whether to be readonly | _boolean_ | `false` |
| is-link | Whether to show link icon | _boolean_ | `true` |
| lazy-render `v3.4.5` | Whether to lazy render util opened | _boolean_ | `true` |
| lazy-render | Whether to lazy render util opened | _boolean_ | `true` |
| title-class | Title className | _string_ | - |
| value-class | Value className | _string_ | - |
| label-class | Label className | _string_ | - |
@ -191,7 +191,7 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Collap
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |
| toggleAll `v3.5.3` | Toggle the expanded status of all collapses | _options?: boolean \| object_ | - |
| toggleAll | Toggle the expanded status of all collapses | _options?: boolean \| object_ | - |
### toggleAll Usage
@ -253,14 +253,14 @@ collapseItemRef.value?.toggle();
### CollapseItem Slots
| Name | Description |
| -------------- | ------------------------ |
| default | Content |
| title | Custom header title |
| value | Custom header value |
| label `v3.1.1` | Custom header label |
| icon | Custom header left icon |
| right-icon | Custom header right icon |
| Name | Description |
| ---------- | ------------------------ |
| default | Content |
| title | Custom header title |
| value | Custom header value |
| label | Custom header label |
| icon | Custom header left icon |
| right-icon | Custom header right icon |
## Theming

22
packages/vant/src/collapse/README.zh-CN.md
View File

@ -201,8 +201,8 @@ export default {
| border | 是否显示内边框 | _boolean_ | `true` |
| is-link | 是否展示标题栏右侧箭头并开启点击反馈 | _boolean_ | `true` |
| disabled | 是否禁用面板 | _boolean_ | `false` |
| readonly `v3.0.12` | 是否为只读状态，只读状态下无法操作面板 | _boolean_ | `false` |
| lazy-render `v3.4.5` | 是否在首次展开时才渲染面板内容 | _boolean_ | `true` |
| readonly | 是否为只读状态，只读状态下无法操作面板 | _boolean_ | `false` |
| lazy-render | 是否在首次展开时才渲染面板内容 | _boolean_ | `true` |
| title-class | 左侧标题额外类名 | _string_ | - |
| value-class | 右侧内容额外类名 | _string_ | - |
| label-class | 描述信息额外类名 | _string_ | - |
@ -213,7 +213,7 @@ export default {
| 方法名 | 说明 | 参数 | 返回值 |
| --- | --- | --- | --- |
| toggleAll `v3.5.3` | 切换所有面板展开状态，传 `true` 为全部展开，`false` 为全部收起，不传参为全部切换 | _options?: boolean \| object_ | - |
| toggleAll | 切换所有面板展开状态，传 `true` 为全部展开，`false` 为全部收起，不传参为全部切换 | _options?: boolean \| object_ | - |
### toggleAll 方法示例
@ -275,14 +275,14 @@ collapseItemRef.value?.toggle();
### CollapseItem Slots
| 名称 | 说明 |
| -------------- | -------------------- |
| default | 面板内容 |
| title | 自定义标题栏左侧内容 |
| value | 自定义标题栏右侧内容 |
| label `v3.1.1` | 自定义标题栏描述信息 |
| icon | 自定义标题栏左侧图标 |
| right-icon | 自定义标题栏右侧图标 |
| 名称 | 说明 |
| ---------- | -------------------- |
| default | 面板内容 |
| title | 自定义标题栏左侧内容 |
| value | 自定义标题栏右侧内容 |
| label | 自定义标题栏描述信息 |
| icon | 自定义标题栏左侧图标 |
| right-icon | 自定义标题栏右侧图标 |
## 主题定制

6
packages/vant/src/config-provider/README.md
View File

@ -316,9 +316,9 @@ There are all **Basic Variables** below, for component CSS Variables, please ref
| theme-vars | Theme variables | _object_ | - |
| theme-vars-dark | Theme variables that work in dark mode，will override `theme-vars` | _object_ | - |
| theme-vars-light | Theme variables that work in light mode, will override `theme-vars` | _object_ | - |
| z-index `v3.6.0` | Set the z-index of all popup components, this property takes effect globally | _number_ | `2000` |
| tag `v3.1.2` | HTML Tag of root element | _string_ | `div` |
| icon-prefix `v3.1.3` | Icon className prefix | _string_ | `van-icon` |
| z-index | Set the z-index of all popup components, this property takes effect globally | _number_ | `2000` |
| tag | HTML Tag of root element | _string_ | `div` |
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
### Types

6
packages/vant/src/config-provider/README.zh-CN.md
View File

@ -318,9 +318,9 @@ Vant 中的 CSS 变量分为 **基础变量** 和 **组件变量**。组件变
| theme-vars | 自定义主题变量，局部生效 | _object_ | - |
| theme-vars-dark | 仅在深色模式下生效的主题变量，优先级高于 `theme-vars` | _object_ | - |
| theme-vars-light | 仅在浅色模式下生效的主题变量，优先级高于 `theme-vars` | _object_ | - |
| tag `v3.1.2` | 根节点对应的 HTML 标签名 | _string_ | `div` |
| z-index `v3.6.0` | 设置所有弹窗类组件的 z-index，该属性对全局生效 | _number_ | `2000` |
| icon-prefix `v3.1.3` | 所有图标的类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| tag | 根节点对应的 HTML 标签名 | _string_ | `div` |
| z-index | 设置所有弹窗类组件的 z-index，该属性对全局生效 | _number_ | `2000` |
| icon-prefix | 所有图标的类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
### 类型定义

8
packages/vant/src/coupon-list/README.md
View File

@ -129,10 +129,10 @@ export default {
### CouponList Slots
| Name | Description |
| ------------------------------ | ------------------------------- |
| list-footer `v3.0.18` | Coupon list bottom |
| disabled-list-footer `v3.0.18` | Unavailable coupons list bottom |
| Name | Description |
| -------------------- | ------------------------------- |
| list-footer | Coupon list bottom |
| disabled-list-footer | Unavailable coupons list bottom |
### Data Structure of Coupon

8
packages/vant/src/coupon-list/README.zh-CN.md
View File

@ -131,10 +131,10 @@ export default {
### CouponList Slots
| 名称 | 说明 |
| ------------------------------ | -------------------- |
| list-footer `v3.0.18` | 优惠券列表底部 |
| disabled-list-footer `v3.0.18` | 不可用优惠券列表底部 |
| 名称 | 说明 |
| -------------------- | -------------------- |
| list-footer | 优惠券列表底部 |
| disabled-list-footer | 不可用优惠券列表底部 |
### Coupon 数据结构

18
packages/vant/src/dialog/README.md
View File

@ -153,10 +153,10 @@ Vant exports following Dialog utility functions:
| showCancelButton | Whether to show cancel button | _boolean_ | `false` |
| cancelButtonText | Cancel button text | _string_ | `Cancel` |
| cancelButtonColor | Cancel button color | _string_ | `black` |
| cancelButtonDisabled `v3.5.0` | Whether to disable cancel button | _boolean_ | `false` |
| cancelButtonDisabled | Whether to disable cancel button | _boolean_ | `false` |
| confirmButtonText | Confirm button text | _string_ | `Confirm` |
| confirmButtonColor | Confirm button color | _string_ | `#ee0a24` |
| confirmButtonDisabled `v3.5.0` | Whether to disable confirm button | _boolean_ | `false` |
| confirmButtonDisabled | Whether to disable confirm button | _boolean_ | `false` |
| overlay | Whether to show overlay | _boolean_ | `true` |
| overlayClass | Custom overlay class | _string \| Array \| object_ | - |
| overlayStyle | Custom overlay style | _object_ | - |
@ -182,10 +182,10 @@ Vant exports following Dialog utility functions:
| show-cancel-button | Whether to show cancel button | _boolean_ | `false` |
| cancel-button-text | Cancel button text | _string_ | `Cancel` |
| cancel-button-color | Cancel button color | _string_ | `black` |
| cancel-button-disabled `v3.5.0` | Whether to disable cancel button | _boolean_ | `false` |
| cancel-button-disabled | Whether to disable cancel button | _boolean_ | `false` |
| confirm-button-text | Confirm button text | _string_ | `Confirm` |
| confirm-button-color | Confirm button color | _string_ | `#ee0a24` |
| confirm-button-disabled `v3.5.0` | Whether to disable confirm button | _boolean_ | `false` |
| confirm-button-disabled | Whether to disable confirm button | _boolean_ | `false` |
| z-index | Set the z-index to a fixed value | _number \| string_ | `2000+` |
| overlay | Whether to show overlay | _boolean_ | `true` |
| overlay-class | Custom overlay class | _string_ | - |
@ -212,11 +212,11 @@ Vant exports following Dialog utility functions:
### Slots
| Name | Description |
| ---------------- | -------------- |
| default | Custom message |
| title | Custom title |
| footer `v3.0.11` | Custom footer |
| Name | Description |
| ------- | -------------- |
| default | Custom message |
| title | Custom title |
| footer | Custom footer |
### Types

18
packages/vant/src/dialog/README.zh-CN.md
View File

@ -172,10 +172,10 @@ Vant 中导出了以下 Dialog 相关的辅助函数：
| showCancelButton | 是否展示取消按钮 | _boolean_ | `false` |
| confirmButtonText | 确认按钮文案 | _string_ | `确认` |
| confirmButtonColor | 确认按钮颜色 | _string_ | `#ee0a24` |
| confirmButtonDisabled `v3.5.0` | 是否禁用确认按钮 | _boolean_ | `false` |
| confirmButtonDisabled | 是否禁用确认按钮 | _boolean_ | `false` |
| cancelButtonText | 取消按钮文案 | _string_ | `取消` |
| cancelButtonColor | 取消按钮颜色 | _string_ | `black` |
| cancelButtonDisabled `v3.5.0` | 是否禁用取消按钮 | _boolean_ | `false` |
| cancelButtonDisabled | 是否禁用取消按钮 | _boolean_ | `false` |
| overlay | 是否展示遮罩层 | _boolean_ | `true` |
| overlayClass | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlayStyle | 自定义遮罩层样式 | _object_ | - |
@ -203,10 +203,10 @@ Vant 中导出了以下 Dialog 相关的辅助函数：
| show-cancel-button | 是否展示取消按钮 | _boolean_ | `false` |
| confirm-button-text | 确认按钮文案 | _string_ | `确认` |
| confirm-button-color | 确认按钮颜色 | _string_ | `#ee0a24` |
| confirm-button-disabled `v3.5.0` | 是否禁用确认按钮 | _boolean_ | `false` |
| confirm-button-disabled | 是否禁用确认按钮 | _boolean_ | `false` |
| cancel-button-text | 取消按钮文案 | _string_ | `取消` |
| cancel-button-color | 取消按钮颜色 | _string_ | `black` |
| cancel-button-disabled `v3.5.0` | 是否禁用取消按钮 | _boolean_ | `false` |
| cancel-button-disabled | 是否禁用取消按钮 | _boolean_ | `false` |
| z-index | 将弹窗的 z-index 层级设置为一个固定值 | _number \| string_ | `2000+` |
| overlay | 是否展示遮罩层 | _boolean_ | `true` |
| overlay-class | 自定义遮罩层类名 | _string_ | - |
@ -237,11 +237,11 @@ Vant 中导出了以下 Dialog 相关的辅助函数：
通过组件调用 `Dialog` 时，支持以下插槽：
| 名称 | 说明 |
| ---------------- | ------------------ |
| default | 自定义内容 |
| title | 自定义标题 |
| footer `v3.0.11` | 自定义底部按钮区域 |
| 名称 | 说明 |
| ------- | ------------------ |
| default | 自定义内容 |
| title | 自定义标题 |
| footer | 自定义底部按钮区域 |
### 类型定义

30
packages/vant/src/field/README.md
View File

@ -265,7 +265,7 @@ Use `label-align` prop to align the input value.
| v-model | Input value | _number \| string_ | - |
| label | Left side label | _string_ | - |
| name | As the identifier when submitting the form | _string_ | - |
| id `v3.2.2` | Input id, the for attribute of the label also will be set | _string_ | `van-field-n-input` |
| id | Input id, the for attribute of the label also will be set | _string_ | `van-field-n-input` |
| type | Input type, support all [native types](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types) and `digit` type | _FieldType_ | `text` |
| size | Size, can be set to `large` | _string_ | - |
| maxlength | Max length of value | _number \| string_ | - |
@ -277,7 +277,7 @@ Use `label-align` prop to align the input value.
| required | Whether to show required mark | _boolean_ | `false` |
| center | Whether to center content vertically | _boolean_ | `true` |
| clearable | Whether to be clearable | _boolean_ | `false` |
| clear-icon `v3.0.12` | Clear icon name | _string_ | `clear` |
| clear-icon | Clear icon name | _string_ | `clear` |
| clear-trigger | When to display the clear icon, `always` means to display the icon when value is not empty, `focus` means to display the icon when input is focused | _FieldClearTrigger_ | `focus` |
| clickable | Whether to show click feedback when clicked | _boolean_ | `false` |
| is-link | Whether to show link icon | _boolean_ | `false` |
@ -298,8 +298,8 @@ Use `label-align` prop to align the input value.
| right-icon | Right side icon name | _string_ | - |
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
| rules | Form validation rules | _FieldRule[]_ | - |
| autocomplete `v3.0.3` | HTML native attribute, see [MDN - autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) | _string_ | - |
| enterkeyhint `v3.4.8` | HTML native attribute, see [MDN - enterkeyhint](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint)<br> | _string_ | - |
| autocomplete | HTML native attribute, see [MDN - autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) | _string_ | - |
| enterkeyhint | HTML native attribute, see [MDN - enterkeyhint](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint)<br> | _string_ | - |
### Events
@ -313,8 +313,8 @@ Use `label-align` prop to align the input value.
| click-input | Emitted when the input is clicked | _event: MouseEvent_ |
| click-left-icon | Emitted when the left icon is clicked | _event: MouseEvent_ |
| click-right-icon | Emitted when the right icon is clicked | _event: MouseEvent_ |
| start-validate `v3.5.1` | Emitted when start validation | - |
| end-validate `v3.5.1` | Emitted when end validation | _{ status: string, message: string }_ |
| start-validate | Emitted when start validation | - |
| end-validate | Emitted when end validation | _{ status: string, message: string }_ |
### Methods
@ -361,15 +361,15 @@ fieldRef.value?.focus();
### Slots
| Name | Description | SlotProps |
| ---------------------- | --------------------------- | --------------------- |
| label | Custom label | - |
| input | Custom input | - |
| left-icon | Custom left icon | - |
| right-icon | Custom right icon | - |
| button | Insert button | - |
| error-message `v3.2.5` | Custom error message | _{ message: string }_ |
| extra | Custom content on the right | - |
| Name | Description | SlotProps |
| ------------- | --------------------------- | --------------------- |
| label | Custom label | - |
| input | Custom input | - |
| left-icon | Custom left icon | - |
| right-icon | Custom right icon | - |
| button | Insert button | - |
| error-message | Custom error message | _{ message: string }_ |
| extra | Custom content on the right | - |
## Theming

14
packages/vant/src/field/README.zh-CN.md
View File

@ -284,7 +284,7 @@ export default {
| v-model | 当前输入的值 | _number \| string_ | - |
| label | 输入框左侧文本 | _string_ | - |
| name | 名称，作为提交表单时的标识符 | _string_ | - |
| id `v3.2.2` | 输入框 id，同时会设置 label 的 for 属性 | _string_ | `van-field-n-input` |
| id | 输入框 id，同时会设置 label 的 for 属性 | _string_ | `van-field-n-input` |
| type | 输入框类型, 支持原生 input 标签的所有 [type 属性](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/input#%3Cinput%3E_types)，额外支持了 `digit` 类型 | _FieldType_ | `text` |
| size | 大小，可选值为 `large` | _string_ | - |
| maxlength | 输入的最大字符数 | _number \| string_ | - |
@ -296,7 +296,7 @@ export default {
| required | 是否显示表单必填星号 | _boolean_ | `false` |
| center | 是否使内容垂直居中 | _boolean_ | `false` |
| clearable | 是否启用清除图标，点击清除图标后会清空输入框 | _boolean_ | `false` |
| clear-icon `v3.0.12` | 清除图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | `clear` |
| clear-icon | 清除图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | `clear` |
| clear-trigger | 显示清除图标的时机，`always` 表示输入框不为空时展示，<br>`focus` 表示输入框聚焦且不为空时展示 | _FieldClearTrigger_ | `focus` |
| clickable | 是否开启点击反馈 | _boolean_ | `false` |
| is-link | 是否展示右侧箭头并开启点击反馈 | _boolean_ | `false` |
@ -317,8 +317,8 @@ export default {
| right-icon | 右侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | - |
| icon-prefix | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| rules | 表单校验规则，详见 [Form 组件](#/zh-CN/form#rule-shu-ju-jie-gou) | _FieldRule[]_ | - |
| autocomplete `v3.0.3` | HTML 原生属性，用于控制自动完成功能，详见 [MDN - autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) | _string_ | - |
| enterkeyhint `v3.4.8` | HTML 原生属性，用于控制回车键样式，此 API 仅在部分浏览器支持，详见 [MDN - enterkeyhint](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint)<br> | _string_ | - |
| autocomplete | HTML 原生属性，用于控制自动完成功能，详见 [MDN - autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) | _string_ | - |
| enterkeyhint | HTML 原生属性，用于控制回车键样式，此 API 仅在部分浏览器支持，详见 [MDN - enterkeyhint](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint)<br> | _string_ | - |
### Events
@ -332,8 +332,8 @@ export default {
| click-input | 点击输入区域时触发 | _event: MouseEvent_ |
| click-left-icon | 点击左侧图标时触发 | _event: MouseEvent_ |
| click-right-icon | 点击右侧图标时触发 | _event: MouseEvent_ |
| start-validate `v3.5.1` | 开始表单校验时触发 | - |
| end-validate `v3.5.1` | 结束表单校验时触发 | _{ status: string, message: string }_ |
| start-validate | 开始表单校验时触发 | - |
| end-validate | 结束表单校验时触发 | _{ status: string, message: string }_ |
### 方法
@ -387,7 +387,7 @@ fieldRef.value?.focus();
| left-icon | 自定义输入框头部图标 | - |
| right-icon | 自定义输入框尾部图标 | - |
| button | 自定义输入框尾部按钮 | - |
| error-message `v3.2.5` | 自定义底部错误提示文案 | _{ message: string }_ |
| error-message | 自定义底部错误提示文案 | _{ message: string }_ |
| extra | 自定义输入框最右侧的额外内容 | - |
## 主题定制

6
packages/vant/src/form/README.md
View File

@ -515,7 +515,7 @@ export default {
| pattern | Regexp pattern, if the regexp cannot match, means that the validation fails | _RegExp_ |
| trigger | When to validate the form, priority is higher than the `validate-trigger` of the Form component, can be set to `onChange`, `onBlur`, `onSubmit` | _string \| string[]_ |
| formatter | Format value before validate | _(value, rule) => any_ |
| validateEmpty `v3.6.0` | Controls whether the `validator` and `pattern` options to verify empty values, the default value is `true`, you can set to `false` to disable this behavior | _boolean_ |
| validateEmpty | Controls whether the `validator` and `pattern` options to verify empty values, the default value is `true`, you can set to `false` to disable this behavior | _boolean_ |
### validate-trigger
@ -539,10 +539,10 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Form i
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |
| submit | Submit form | - | - |
| getValues `v3.4.8` | Get current form values | - | _Record<string, unknown>_ |
| getValues | Get current form values | - | _Record<string, unknown>_ |
| validate | Validate form | _name?: string \| string[]_ | _Promise\<void\>_ |
| resetValidation | Reset validation | _name?: string \| string[]_ | - |
| getValidationStatus `v3.5.0` | Get validation status of all fields，status can be `passed`、`failed`、`unvalidated` | - | _Record\<string, FieldValidationStatus\>_ |
| getValidationStatus | Get validation status of all fields，status can be `passed`、`failed`、`unvalidated` | - | _Record\<string, FieldValidationStatus\>_ |
| scrollToField | Scroll to field | _name: string, alignToTop: boolean_ | - |
### Types

6
packages/vant/src/form/README.zh-CN.md
View File

@ -551,7 +551,7 @@ export default {
| pattern | 通过正则表达式进行校验，正则无法匹配表示校验不通过 | _RegExp_ |
| trigger | 设置本项规则的触发时机，优先级高于 Form 组件设置的 `validate-trigger` 属性，可选值为 `onChange`、`onBlur`、`onSubmit` | _string \| string[]_ |
| formatter | 格式化函数，将表单项的值转换后进行校验 | _(value, rule) => any_ |
| validateEmpty `v3.6.0` | 设置 `validator` 和 `pattern` 是否要对空值进行校验，默认值为 `true`，可以设置为 `false` 来禁用该行为 | _boolean_ |
| validateEmpty | 设置 `validator` 和 `pattern` 是否要对空值进行校验，默认值为 `true`，可以设置为 `false` 来禁用该行为 | _boolean_ |
### validate-trigger 可选值
@ -577,10 +577,10 @@ export default {
| 方法名 | 说明 | 参数 | 返回值 |
| --- | --- | --- | --- |
| submit | 提交表单，与点击提交按钮的效果等价 | - | - |
| getValues `v3.4.8` | 获取所有表单项当前的值 | - | _Record<string, unknown>_ |
| getValues | 获取所有表单项当前的值 | - | _Record<string, unknown>_ |
| validate | 验证表单，支持传入一个或多个 `name` 来验证单个或部分表单项，不传入 `name` 时，会验证所有表单项 | _name?: string \| string[]_ | _Promise\<void\>_ |
| resetValidation | 重置表单项的验证提示，支持传入一个或多个 `name` 来重置单个或部分表单项，不传入 `name` 时，会重置所有表单项 | _name?: string \| string[]_ | - |
| getValidationStatus `v3.5.0` | 获取所有表单项的校验状态，状态包括 `passed`、`failed`、`unvalidated` | - | _Record\<string, FieldValidationStatus\>_ |
| getValidationStatus | 获取所有表单项的校验状态，状态包括 `passed`、`failed`、`unvalidated` | - | _Record\<string, FieldValidationStatus\>_ |
| scrollToField | 滚动到对应表单项的位置，默认滚动到顶部，第二个参数传 false 可滚动至底部 | _name: string, alignToTop: boolean_ | - |
### 类型定义

4
packages/vant/src/grid/README.md
View File

@ -118,7 +118,7 @@ app.use(GridItem);
| square | Whether to be square shape | _boolean_ | `false` |
| clickable | Whether to show click feedback when clicked | _boolean_ | `false` |
| direction | Content arrangement direction, can be set to `horizontal` | _string_ | `vertical` |
| reverse `v3.1.0` | Whether to reverse the position of icon and text | _boolean_ | `false` |
| reverse | Whether to reverse the position of icon and text | _boolean_ | `false` |
### GridItem Props
@ -130,7 +130,7 @@ app.use(GridItem);
| icon-color | Icon color | _string_ | - |
| dot | Whether to show red dot | _boolean_ | `false` |
| badge | Content of the badge | _number \| string_ | - |
| badge-props `v3.2.8` | Props of Badge, see [Badge - props](#/en-US/badge#props) | _BadgeProps_ | - |
| badge-props | Props of Badge, see [Badge - props](#/en-US/badge#props) | _BadgeProps_ | - |
| url | Link URL | _string_ | - |
| to | Target route of the link, same as to of vue-router | _string \| object_ | - |
| replace | If true, the navigation will not leave a history record | _boolean_ | `false` |

4
packages/vant/src/grid/README.zh-CN.md
View File

@ -134,7 +134,7 @@ app.use(GridItem);
| square | 是否将格子固定为正方形 | _boolean_ | `false` |
| clickable | 是否开启格子点击反馈 | _boolean_ | `false` |
| direction | 格子内容排列的方向，可选值为 `horizontal` | _string_ | `vertical` |
| reverse `v3.1.0` | 是否调换图标和文本的位置 | _boolean_ | `false` |
| reverse | 是否调换图标和文本的位置 | _boolean_ | `false` |
### GridItem Props
@ -146,7 +146,7 @@ app.use(GridItem);
| icon-color | 图标颜色，等同于 Icon 组件的 [color 属性](#/zh-CN/icon#props) | _string_ | - |
| dot | 是否显示图标右上角小红点 | _boolean_ | `false` |
| badge | 图标右上角徽标的内容 | _number \| string_ | - |
| badge-props `v3.2.8` | 自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props) | _BadgeProps_ | - |
| badge-props | 自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props) | _BadgeProps_ | - |
| url | 点击后跳转的链接地址 | _string_ | - |
| to | 点击后跳转的目标路由对象，等同于 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - |
| replace | 是否在跳转时替换当前页面历史 | _boolean_ | `false` |

2
packages/vant/src/icon/README.md
View File

@ -96,7 +96,7 @@ Use `size` prop to set icon size.
| name | Icon name or URL | _string_ | `''` |
| dot | Whether to show red dot | _boolean_ | `false` |
| badge | Content of the badge | _number \| string_ | `''` |
| badge-props `v3.2.8` | Props of Badge, see [Badge - props](#/en-US/badge#props) | _BadgeProps_ | - |
| badge-props | Props of Badge, see [Badge - props](#/en-US/badge#props) | _BadgeProps_ | - |
| color | Icon color | _string_ | `inherit` |
| size | Icon size | _number \| string_ | `inherit` |
| class-prefix | ClassName prefix | _string_ | `van-icon` |

2
packages/vant/src/icon/README.zh-CN.md
View File

@ -98,7 +98,7 @@ app.use(Icon);
| name | 图标名称或图片链接 | _string_ | - |
| dot | 是否显示图标右上角小红点 | _boolean_ | `false` |
| badge | 图标右上角徽标的内容 | _number \| string_ | - |
| badge-props `v3.2.8` | 自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props) | _BadgeProps_ | - |
| badge-props | 自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props) | _BadgeProps_ | - |
| color | 图标颜色 | _string_ | `inherit` |
| size | 图标大小，如 `20px` `2em`，默认单位为 `px` | _number \| string_ | `inherit` |
| class-prefix | 类名前缀，用于使用自定义图标 | _string_ | `van-icon` |

14
packages/vant/src/image-preview/README.md
View File

@ -202,9 +202,9 @@ Vant exports following ImagePreview utility functions:
| closeable | Whether to show close icon | _boolean_ | `false` |
| closeIcon | Close icon name | _string_ | `clear` |
| closeIconPosition | Close icon position, can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| transition `v3.0.8` | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |
| overlayClass `v3.2.8` | Custom overlay class | _string \| Array \| object_ | - |
| overlayStyle `v3.0.8` | Custom overlay style | _object_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |
| overlayClass | Custom overlay class | _string \| Array \| object_ | - |
| overlayStyle | Custom overlay style | _object_ | - |
| teleport | Specifies a target element where ImagePreview will be mounted | _string \| Element_ | - |
### Props
@ -226,9 +226,9 @@ Vant exports following ImagePreview utility functions:
| closeable | Whether to show close icon | _boolean_ | `false` |
| close-icon | Close icon name | _string_ | `clear` |
| close-icon-position | Close icon position, can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| transition `v3.0.8` | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |
| overlay-class `v3.2.8` | Custom overlay class | _string \| Array \| object_ | - |
| overlay-style `v3.0.8` | Custom overlay style | _object_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |
| overlay-class | Custom overlay class | _string \| Array \| object_ | - |
| overlay-style | Custom overlay style | _object_ | - |
| teleport | Specifies a target element where ImagePreview will be mounted | _string \| Element_ | - |
### Events
@ -279,7 +279,7 @@ imagePreviewRef.value?.swipeTo(1);
| --- | --- | --- |
| index | Custom index | { index: index of current image } |
| cover | Custom content that covers the image preview | - |
| image `v3.6.5` | Custom image content | { src: current image src } |
| image | Custom image content | { src: current image src } |
### onClose Parameters

24
packages/vant/src/image-preview/README.zh-CN.md
View File

@ -120,7 +120,7 @@ setTimeout(() => {
```html
<van-image-preview v-model:show="show" :images="images" @change="onChange">
<template v-slot:index>第{{ index + 1 }}页</template>
<template v-slot:index>第{{ index + 1 }}页</template>
</van-image-preview>
```
@ -215,9 +215,9 @@ Vant 中导出了以下 ImagePreview 相关的辅助函数：
| closeable | 是否显示关闭图标 | _boolean_ | `false` |
| closeIcon | 关闭图标名称或图片链接 | _string_ | `clear` |
| closeIconPosition | 关闭图标位置，可选值为 `top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` |
| transition `v3.0.8` | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | `van-fade` |
| overlayClass `v3.2.8` | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlayStyle `v3.0.8` | 自定义遮罩层样式 | _object_ | - |
| transition | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | `van-fade` |
| overlayClass | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlayStyle | 自定义遮罩层样式 | _object_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
### Props
@ -241,9 +241,9 @@ Vant 中导出了以下 ImagePreview 相关的辅助函数：
| closeable | 是否显示关闭图标 | _boolean_ | `false` |
| close-icon | 关闭图标名称或图片链接 | _string_ | `clear` |
| close-icon-position | 关闭图标位置，可选值为 `top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` |
| transition `v3.0.8` | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | `van-fade` |
| overlay-class `v3.2.8` | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlay-style `v3.0.8` | 自定义遮罩层样式 | _object_ | - |
| transition | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | `van-fade` |
| overlay-class | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlay-style | 自定义遮罩层样式 | _object_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
### Events
@ -294,11 +294,11 @@ imagePreviewRef.value?.swipeTo(1);
通过组件调用 `ImagePreview` 时，支持以下插槽：
| 名称 | 说明 | 参数 |
| -------------- | ------------------------------ | ------------------------- |
| index | 自定义页码内容 | { index: 当前图片的索引 } |
| cover | 自定义覆盖在图片预览上方的内容 | - |
| image `v3.6.5` | 自定义图片内容 | { src: 当前资源地址 } |
| 名称 | 说明 | 参数 |
| ----- | ------------------------------ | ------------------------- |
| index | 自定义页码内容 | { index: 当前图片的索引 } |
| cover | 自定义覆盖在图片预览上方的内容 | - |
| image | 自定义图片内容 | { src: 当前资源地址 } |
### onClose 回调参数

4
packages/vant/src/image/README.md
View File

@ -95,7 +95,7 @@ app.use(Lazyload);
| --- | --- | --- | --- |
| src | Src | _string_ | - |
| fit | Fit mode, same as [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) | _string_ | `fill` |
| position `v3.4.2` | Position, same as [object-position](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position), can be set to `top` `right` `bottom` `left` or `string` | _string_ | `center` |
| position | Position, same as [object-position](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position), can be set to `top` `right` `bottom` `left` or `string` | _string_ | `center` |
| alt | Alt | _string_ | - |
| width | Width | _number \| string_ | - |
| height | Height | _number \| string_ | - |
@ -107,7 +107,7 @@ app.use(Lazyload);
| show-loading | Whether to show loading placeholder | _boolean_ | `true` |
| error-icon | Error icon | _string_ | `photo-fail` |
| loading-icon | Loading icon | _string_ | `photo` |
| icon-size `v3.0.11` | Icon size | _number \| string_ | `32px` |
| icon-size | Icon size | _number \| string_ | `32px` |
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
### fit optional value

4
packages/vant/src/image/README.zh-CN.md
View File

@ -121,7 +121,7 @@ app.use(Lazyload);
| --- | --- | --- | --- |
| src | 图片链接 | _string_ | - |
| fit | 图片填充模式，等同于原生的 [object-fit](https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit) 属性 | _string_ | `fill` |
| position `v3.4.2` | 图片位置，等同于原生的 [object-position](https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-position) 属性，可选值为 `top` `right` `bottom` `left` 或 `string` | _string_ | `center` |
| position | 图片位置，等同于原生的 [object-position](https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-position) 属性，可选值为 `top` `right` `bottom` `left` 或 `string` | _string_ | `center` |
| alt | 替代文本 | _string_ | - |
| width | 宽度，默认单位为 `px` | _number \| string_ | - |
| height | 高度，默认单位为 `px` | _number \| string_ | - |
@ -133,7 +133,7 @@ app.use(Lazyload);
| show-loading | 是否展示图片加载中提示 | _boolean_ | `true` |
| error-icon | 失败时提示的图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | `photo-fail` |
| loading-icon | 加载时提示的图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | `photo` |
| icon-size `v3.0.11` | 加载图标和失败图标的大小 | _number \| string_ | `32px` |
| icon-size | 加载图标和失败图标的大小 | _number \| string_ | `32px` |
| icon-prefix | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
### 图片填充模式

2
packages/vant/src/index-bar/README.md
View File

@ -76,7 +76,7 @@ export default {
| sticky | Whether to enable anchor sticky top | _boolean_ | `true` |
| sticky-offset-top | Anchor offset top when sticky | _number_ | `0` |
| highlight-color | Index character highlight color | _string_ | `#1989fa` |
| teleport `v3.0.19` | Specifies a target element where IndexBar will be mounted | _string \| Element_ | - |
| teleport | Specifies a target element where IndexBar will be mounted | _string \| Element_ | - |
### IndexAnchor Props

2
packages/vant/src/index-bar/README.zh-CN.md
View File

@ -80,7 +80,7 @@ export default {
| sticky | 是否开启锚点自动吸顶 | _boolean_ | `true` |
| sticky-offset-top | 锚点自动吸顶时与顶部的距离 | _number_ | `0` |
| highlight-color | 索引字符高亮颜色 | _string_ | `#1989fa` |
| teleport `v3.0.19` | 指定索引栏挂载的节点 | _string \| Element_ | - |
| teleport | 指定索引栏挂载的节点 | _string \| Element_ | - |
### IndexAnchor Props

6
packages/vant/src/notice-bar/README.md
View File

@ -117,9 +117,9 @@ app.use(NoticeBar);
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get NoticeBar instance and call instance methods.
| Name | Description | Attribute | Return value |
| -------------- | --------------- | --------- | ------------ |
| reset `v3.1.1` | Reset NoticeBar | - | - |
| Name | Description | Attribute | Return value |
| ----- | --------------- | --------- | ------------ |
| reset | Reset NoticeBar | - | - |
### Types

6
packages/vant/src/notice-bar/README.zh-CN.md
View File

@ -133,9 +133,9 @@ app.use(NoticeBar);
通过 ref 可以获取到 NoticeBar 实例并调用实例方法，详见[组件实例方法](#/zh-CN/advanced-usage#zu-jian-shi-li-fang-fa)。
| 方法名 | 说明 | 参数 | 返回值 |
| -------------- | -------------------- | ---- | ------ |
| reset `v3.1.1` | 重置通知栏到初始状态 | - | - |
| 方法名 | 说明 | 参数 | 返回值 |
| ------ | -------------------- | ---- | ------ |
| reset | 重置通知栏到初始状态 | - | - |
### 类型定义

4
packages/vant/src/notify/README.md
View File

@ -128,11 +128,11 @@ Vant exports following Notify utility functions:
| message | Message | _string_ | - |
| duration | Duration(ms), won't disappear if value is 0 | _number \| string_ | `3000` |
| z-index | Set the z-index to a fixed value | _number \| string_ | `2000+` |
| position `v3.4.0` | Position, can be set to `bottom` | _NotifyPosition_ | `top` |
| position | Position, can be set to `bottom` | _NotifyPosition_ | `top` |
| color | Message color | _string_ | `white` |
| background | Background color | _string_ | - |
| className | Custom className | _string \| Array \| object_ | - |
| lockScroll `v3.0.7` | Whether to lock background scroll | _boolean_ | `false` |
| lockScroll | Whether to lock background scroll | _boolean_ | `false` |
| onClick | Callback function after click | _(event: MouseEvent) => void_ | - |
| onOpened | Callback function after opened | _() => void_ | - |
| onClose | Callback function after close | _() => void_ | - |

4
packages/vant/src/notify/README.zh-CN.md
View File

@ -143,11 +143,11 @@ Vant 中导出了以下 Notify 相关的辅助函数：
| message | 展示文案，支持通过`\n`换行 | _string_ | - |
| duration | 展示时长(ms)，值为 0 时，notify 不会消失 | _number \| string_ | `3000` |
| z-index | 将组件的 z-index 层级设置为一个固定值 | _number \| string_ | `2000+` |
| position `v3.4.0` | 弹出位置，可选值为 `bottom` | _NotifyPosition_ | `top` |
| position | 弹出位置，可选值为 `bottom` | _NotifyPosition_ | `top` |
| color | 字体颜色 | _string_ | `white` |
| background | 背景颜色 | _string_ | - |
| className | 自定义类名 | _string \| Array \| object_ | - |
| lockScroll `v3.0.7` | 是否锁定背景滚动 | _boolean_ | `false` |
| lockScroll | 是否锁定背景滚动 | _boolean_ | `false` |
| onClick | 点击时的回调函数 | _(event: MouseEvent): void_ | - |
| onOpened | 完全展示后的回调函数 | _() => void_ | - |
| onClose | 关闭时的回调函数 | _() => void_ | - |

2
packages/vant/src/number-keyboard/README.md
View File

@ -180,7 +180,7 @@ export default {
| delete-button-text | Delete button text | _string_ | Delete Icon |
| close-button-loading | Whether to show loading close button in custom theme | _boolean_ | `false` |
| show-delete-key | Whether to show delete button | _boolean_ | `true` |
| blur-on-close `v3.0.6` | Whether to emit blur event when clicking close button | _boolean_ | `true` |
| blur-on-close | Whether to emit blur event when clicking close button | _boolean_ | `true` |
| hide-on-click-outside | Whether to hide keyboard when outside is clicked | _boolean_ | `true` |
| teleport | Specifies a target element where NumberKeyboard will be mounted | _string \| Element_ | - |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` |

2
packages/vant/src/number-keyboard/README.zh-CN.md
View File

@ -187,7 +187,7 @@ export default {
| delete-button-text | 删除按钮文字，空则展示删除图标 | _string_ | - |
| close-button-loading | 是否将关闭按钮设置为加载中状态，仅在 `theme="custom"` 时有效 | _boolean_ | `false` |
| show-delete-key | 是否展示删除图标 | _boolean_ | `true` |
| blur-on-close `v3.0.6` | 是否在点击关闭按钮时触发 blur 事件 | _boolean_ | `true` |
| blur-on-close | 是否在点击关闭按钮时触发 blur 事件 | _boolean_ | `true` |
| hide-on-click-outside | 是否在点击外部时收起键盘 | _boolean_ | `true` |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `true` |

2
packages/vant/src/overlay/README.md
View File

@ -73,7 +73,7 @@ export default {
| class-name | ClassName | _string_ | - |
| custom-class | Custom style | _object_ | - |
| lock-scroll | Whether to lock background scroll | _boolean_ | `true` |
| lazy-render `v3.4.2` | Whether to lazy render util appeared | _boolean_ | `true` |
| lazy-render | Whether to lazy render util appeared | _boolean_ | `true` |
### Events

2
packages/vant/src/overlay/README.zh-CN.md
View File

@ -75,7 +75,7 @@ export default {
| class-name | 自定义类名 | _string_ | - |
| custom-style | 自定义样式 | _object_ | - |
| lock-scroll | 是否锁定背景滚动，锁定时蒙层里的内容也将无法滚动 | _boolean_ | `true` |
| lazy-render `v3.4.2` | 是否在显示时才渲染节点 | _boolean_ | `true` |
| lazy-render | 是否在显示时才渲染节点 | _boolean_ | `true` |
### Events

2
packages/vant/src/picker/README.zh-CN.md
View File

@ -385,7 +385,7 @@ export default {
| 名称 | 说明 | 参数 |
| --- | --- | --- |
| toolbar `v3.1.2` | 自定义整个顶部栏的内容 | - |
| toolbar | 自定义整个顶部栏的内容 | - |
| title | 自定义标题内容 | - |
| confirm | 自定义确认按钮内容 | - |
| cancel | 自定义取消按钮内容 | - |

12
packages/vant/src/popover/README.md
View File

@ -253,14 +253,14 @@ export default {
| duration | Transition duration, unit second | _number \| string_ | `0.3` |
| offset | Distance to reference | _[number, number]_ | `[0, 8]` |
| overlay | Whether to show overlay | _boolean_ | `false` |
| overlay-class `v3.0.10` | Custom overlay class | _string \| Array \| object_ | - |
| overlay-style `v3.0.10` | Custom overlay style | _object_ | - |
| show-arrow `v3.2.2` | Whether to show arrow | _boolean_ | `true` |
| overlay-class | Custom overlay class | _string \| Array \| object_ | - |
| overlay-style | Custom overlay style | _object_ | - |
| show-arrow | Whether to show arrow | _boolean_ | `true` |
| close-on-click-action | Whether to close when clicking action | _boolean_ | `true` |
| close-on-click-outside | Whether to close when clicking outside | _boolean_ | `true` |
| close-on-click-overlay `v3.0.10` | Whether to close when clicking overlay | _boolean_ | `true` |
| close-on-click-overlay | Whether to close when clicking overlay | _boolean_ | `true` |
| teleport | Specifies a target element where Popover will be mounted | _string \| Element_ | `body` |
| icon-prefix `v3.0.17` | Icon className prefix | _string_ | `van-icon` |
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
### Data Structure of PopoverAction
@ -289,7 +289,7 @@ export default {
| --- | --- | --- |
| default | Custom content | - |
| reference | Reference Element | - |
| action `v3.4.0` | Custom the content of option | _{ action: PopoverAction, index: number }_ |
| action | Custom the content of option | _{ action: PopoverAction, index: number }_ |
### Types

12
packages/vant/src/popover/README.zh-CN.md
View File

@ -263,14 +263,14 @@ export default {
| duration | 动画时长，单位秒，设置为 0 可以禁用动画 | _number \| string_ | `0.3` |
| offset | 出现位置的偏移量 | _[number, number]_ | `[0, 8]` |
| overlay | 是否显示遮罩层 | _boolean_ | `false` |
| overlay-class `v3.0.10` | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlay-style `v3.0.10` | 自定义遮罩层样式 | _object_ | - |
| show-arrow `v3.2.2` | 是否展示小箭头 | _boolean_ | `true` |
| overlay-class | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlay-style | 自定义遮罩层样式 | _object_ | - |
| show-arrow | 是否展示小箭头 | _boolean_ | `true` |
| close-on-click-action | 是否在点击选项后关闭 | _boolean_ | `true` |
| close-on-click-outside | 是否在点击外部元素后关闭菜单 | _boolean_ | `true` |
| close-on-click-overlay `v3.0.10` | 是否在点击遮罩层后关闭菜单 | _boolean_ | `true` |
| close-on-click-overlay | 是否在点击遮罩层后关闭菜单 | _boolean_ | `true` |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | `body` |
| icon-prefix `v3.0.17` | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| icon-prefix | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
### PopoverAction 数据结构
@ -301,7 +301,7 @@ export default {
| --- | --- | --- |
| default | 自定义菜单内容 | - |
| reference | 触发 Popover 显示的元素内容 | - |
| action `v3.4.0` | 自定义选项内容 | _{ action: PopoverAction, index: number }_ |
| action | 自定义选项内容 | _{ action: PopoverAction, index: number }_ |
### 类型定义

12
packages/vant/src/popup/README.md
View File

@ -233,8 +233,8 @@ Use `teleport` prop to specify mount location.
| closeable | Whether to show close icon | _boolean_ | `false` |
| close-icon | Close icon name | _string_ | `cross` |
| close-icon-position | Close Icon Position, can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| before-close `v3.1.4` | Callback function before close | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| icon-prefix `v3.0.18` | Icon className prefix | _string_ | `van-icon` |
| before-close | Callback function before close | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
| transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | - |
| transition-appear | Whether to apply transition on initial render | _boolean_ | `false` |
| teleport | Specifies a target element where Popup will be mounted | _string \| Element_ | - |
@ -255,10 +255,10 @@ Use `teleport` prop to specify mount location.
### Slots
| Name | Description |
| ------------------------- | ------------------------ |
| default | Content of Popup |
| overlay-content `v3.0.18` | Content of Popup overlay |
| Name | Description |
| --------------- | ------------------------ |
| default | Content of Popup |
| overlay-content | Content of Popup overlay |
### Types

12
packages/vant/src/popup/README.zh-CN.md
View File

@ -235,8 +235,8 @@ export default {
| closeable | 是否显示关闭图标 | _boolean_ | `false` |
| close-icon | 关闭图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | `cross` |
| close-icon-position | 关闭图标位置，可选值为 `top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` |
| before-close `v3.1.4` | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| icon-prefix `v3.0.18` | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| before-close | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| icon-prefix | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| transition | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | - |
| transition-appear | 是否在初始渲染时启用过渡动画 | _boolean_ | `false` |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
@ -257,10 +257,10 @@ export default {
### Slots
| 名称 | 说明 |
| ------------------------- | ------------ |
| default | 弹窗内容 |
| overlay-content `v3.0.18` | 遮罩层的内容 |
| 名称 | 说明 |
| --------------- | ------------ |
| default | 弹窗内容 |
| overlay-content | 遮罩层的内容 |
### 类型定义

4
packages/vant/src/pull-refresh/README.md
View File

@ -121,7 +121,7 @@ Use slots to custom tips.
| success-duration | Success text display duration(ms) | _number \| string_ | `500` |
| animation-duration | Animation duration | _number \| string_ | `300` |
| head-height | Height of head | _number \| string_ | `50` |
| pull-distance `v3.0.8` | The distance to trigger the pull refresh | _number \| string_ | same as `head-height` |
| pull-distance | The distance to trigger the pull refresh | _number \| string_ | same as `head-height` |
| disabled | Whether to disable pull refresh | _boolean_ | `false` |
### Events
@ -129,7 +129,7 @@ Use slots to custom tips.
| Event | Description | Parameters |
| --- | --- | --- |
| refresh | Emitted after pulling refresh | - |
| change `v3.5.1` | Emitted when draging or status changed | _{ status: string, distance: number }_ |
| change | Emitted when draging or status changed | _{ status: string, distance: number }_ |
### Slots

10
packages/vant/src/pull-refresh/README.zh-CN.md
View File

@ -124,15 +124,15 @@ export default {
| success-duration | 刷新成功提示展示时长(ms) | _number \| string_ | `500` |
| animation-duration | 动画时长 | _number \| string_ | `300` |
| head-height | 顶部内容高度 | _number \| string_ | `50` |
| pull-distance `v3.0.8` | 触发下拉刷新的距离 | _number \| string_ | 与 `head-height` 一致 |
| pull-distance | 触发下拉刷新的距离 | _number \| string_ | 与 `head-height` 一致 |
| disabled | 是否禁用下拉刷新 | _boolean_ | `false` |
### Events
| 事件名 | 说明 | 回调参数 |
| --- | --- | --- |
| refresh | 下拉刷新时触发 | - |
| change `v3.5.1` | 拖动时或状态改变时触发 | _{ status: string, distance: number }_ |
| 事件名 | 说明 | 回调参数 |
| ------- | ---------------------- | -------------------------------------- |
| refresh | 下拉刷新时触发 | - |
| change | 拖动时或状态改变时触发 | _{ status: string, distance: number }_ |
### Slots

18
packages/vant/src/search/README.md
View File

@ -138,14 +138,14 @@ export default {
| --- | --- | --- | --- |
| v-model | Input value | _number \| string_ | - |
| label | Left side label | _string_ | - |
| name `v3.2.3` | As the identifier when submitting the form | _string_ | - |
| name | As the identifier when submitting the form | _string_ | - |
| shape | Shape of field, can be set to `round` | _string_ | `square` |
| id `v3.2.2` | Input id, the for attribute of the label also will be set | _string_ | `van-search-n-input` |
| id | Input id, the for attribute of the label also will be set | _string_ | `van-search-n-input` |
| background | Background color of field | _string_ | `#f2f2f2` |
| maxlength | Max length of value | _number \| string_ | - |
| placeholder | Placeholder | _string_ | - |
| clearable | Whether to be clearable | _boolean_ | `true` |
| clear-icon `v3.0.12` | Clear icon name | _string_ | `clear` |
| clear-icon | Clear icon name | _string_ | `clear` |
| clear-trigger | When to display the clear icon, `always` means to display the icon when value is not empty, `focus` means to display the icon when input is focused | _string_ | `focus` |
| autofocus | Whether to auto focus, unsupported in iOS | _boolean_ | `false` |
| show-action | Whether to show right action button | _boolean_ | `false` |
@ -153,13 +153,13 @@ export default {
| disabled | Whether to disable field | _boolean_ | `false` |
| readonly | Whether to be readonly | _boolean_ | `false` |
| error | Whether to mark the input content in red | _boolean_ | `false` |
| error-message `v3.0.12` | Error message | _string_ | - |
| formatter `v3.0.12` | Input value formatter | _(val: string) => string_ | - |
| format-trigger `v3.0.12` | When to format value, can be set to `onBlur` | _string_ | `onChange` |
| error-message | Error message | _string_ | - |
| formatter | Input value formatter | _(val: string) => string_ | - |
| format-trigger | When to format value, can be set to `onBlur` | _string_ | `onChange` |
| input-align | Text align of field, can be set to `center` `right` | _string_ | `left` |
| left-icon | Left icon name | _string_ | `search` |
| right-icon | Right icon name | _string_ | - |
| autocomplete `v3.2.3` | [autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) attribute of native input element | _string_ | - |
| autocomplete | [autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) attribute of native input element | _string_ | - |
### Events
@ -170,8 +170,8 @@ export default {
| focus | Emitted when input is focused | _event: Event_ |
| blur | Emitted when input is blurred | _event: Event_ |
| click-input | Emitted when the input is clicked | _event: MouseEvent_ |
| click-left-icon `v3.4.0` | Emitted when the left icon is clicked | _event: MouseEvent_ |
| click-right-icon `v3.4.0` | Emitted when the right icon is clicked | _event: MouseEvent_ |
| click-left-icon | Emitted when the left icon is clicked | _event: MouseEvent_ |
| click-right-icon | Emitted when the right icon is clicked | _event: MouseEvent_ |
| clear | Emitted when the clear icon is clicked | _event: MouseEvent_ |
| cancel | Emitted when the cancel button is clicked | - |

14
packages/vant/src/search/README.zh-CN.md
View File

@ -150,14 +150,14 @@ export default {
| --- | --- | --- | --- |
| v-model | 当前输入的值 | _number \| string_ | - |
| label | 搜索框左侧文本 | _string_ | - |
| name `v3.2.3` | 名称，作为提交表单时的标识符 | _string_ | - |
| name | 名称，作为提交表单时的标识符 | _string_ | - |
| shape | 搜索框形状，可选值为 `round` | _string_ | `square` |
| id `v3.2.2` | 搜索框 id，同时会设置 label 的 for 属性 | _string_ | `van-search-n-input` |
| id | 搜索框 id，同时会设置 label 的 for 属性 | _string_ | `van-search-n-input` |
| background | 搜索框外部背景色 | _string_ | `#f2f2f2` |
| maxlength | 输入的最大字符数 | _number \| string_ | - |
| placeholder | 占位提示文字 | _string_ | - |
| clearable | 是否启用清除图标，点击清除图标后会清空输入框 | _boolean_ | `true` |
| clear-icon `v3.0.12` | 清除图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | `clear` |
| clear-icon | 清除图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | `clear` |
| clear-trigger | 显示清除图标的时机，`always` 表示输入框不为空时展示，<br>`focus` 表示输入框聚焦且不为空时展示 | _string_ | `focus` |
| autofocus | 是否自动聚焦，iOS 系统不支持该属性 | _boolean_ | `false` |
| show-action | 是否在搜索框右侧显示取消按钮 | _boolean_ | `false` |
@ -166,12 +166,12 @@ export default {
| readonly | 是否将输入框设为只读状态，只读状态下无法输入内容 | _boolean_ | `false` |
| error | 是否将输入内容标红 | _boolean_ | `false` |
| error-message | 底部错误提示文案，为空时不展示 | _string_ | - |
| formatter `v3.0.12` | 输入内容格式化函数 | _(val: string) => string_ | - |
| format-trigger `v3.0.12` | 格式化函数触发的时机，可选值为 `onBlur` | _string_ | `onChange` |
| formatter | 输入内容格式化函数 | _(val: string) => string_ | - |
| format-trigger | 格式化函数触发的时机，可选值为 `onBlur` | _string_ | `onChange` |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | _string_ | `left` |
| left-icon | 输入框左侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | `search` |
| right-icon | 输入框右侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props) | _string_ | - |
| autocomplete `v3.2.3` | input 标签原生的[自动完成属性](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) | _string_ | - |
| autocomplete | input 标签原生的[自动完成属性](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) | _string_ | - |
### Events
@ -182,7 +182,7 @@ export default {
| focus | 输入框获得焦点时触发 | _event: Event_ |
| blur | 输入框失去焦点时触发 | _event: Event_ |
| click-input | 点击输入区域时触发 | _event: MouseEvent_ |
| click-left-icon `v3.4.0` | 点击左侧图标时触发 | _event: MouseEvent_ |
| click-left-icon | 点击左侧图标时触发 | _event: MouseEvent_ |
| click-right-icon `3.4.0` | 点击右侧图标时触发 | _event: MouseEvent_ |
| clear | 点击清除按钮后触发 | _event: MouseEvent_ |
| cancel | 点击取消按钮时触发 | - |

14
packages/vant/src/share-sheet/README.md
View File

@ -175,7 +175,7 @@ export default {
| description | Description | _string_ | - |
| duration | Transition duration, unit second | _number \| string_ | `0.3` |
| z-index | Set the z-index to a fixed value | _number \| string_ | `2000+` |
| round `v3.2.6` | Whether to show round corner | _boolean_ | `true` |
| round | Whether to show round corner | _boolean_ | `true` |
| overlay | Whether to show overlay | _boolean_ | `true` |
| overlay-class | Custom overlay class | _string \| Array \| object_ | - |
| overlay-style | Custom overlay style | _object_ | - |
@ -185,7 +185,7 @@ export default {
| close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` |
| teleport | Specifies a target element where ShareSheet will be mounted | _string \| Element_ | - |
| before-close `v3.1.4` | Callback function before close | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| before-close | Callback function before close | _(action: string) => boolean \| Promise\<boolean\>_ | - |
### Data Structure of Option
@ -210,11 +210,11 @@ export default {
### Slots
| Name | Description |
| ---------------- | ----------------------------------- |
| title | Custom title |
| description | Custom description |
| cancel `v3.0.10` | Custom the content of cancel button |
| Name | Description |
| ----------- | ----------------------------------- |
| title | Custom title |
| description | Custom description |
| cancel | Custom the content of cancel button |
### Types

14
packages/vant/src/share-sheet/README.zh-CN.md
View File

@ -187,7 +187,7 @@ export default {
| description | 标题下方的辅助描述文字 | _string_ | - |
| duration | 动画时长，单位秒，设置为 0 可以禁用动画 | _number \| string_ | `0.3` |
| z-index | 将面板的 z-index 层级设置为一个固定值 | _number \| string_ | `2000+` |
| round `v3.2.6` | 是否显示圆角 | _boolean_ | `true` |
| round | 是否显示圆角 | _boolean_ | `true` |
| overlay | 是否显示遮罩层 | _boolean_ | `true` |
| overlay-class | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlay-style | 自定义遮罩层样式 | _object_ | - |
@ -197,7 +197,7 @@ export default {
| close-on-click-overlay | 是否在点击遮罩层后关闭 | _boolean_ | `true` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `true` |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
| before-close `v3.1.4` | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| before-close | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(action: string) => boolean \| Promise\<boolean\>_ | - |
### Option 数据结构
@ -224,11 +224,11 @@ export default {
### Slots
| 名称 | 说明 |
| ---------------- | ------------------ |
| title | 自定义顶部标题 |
| description | 自定义描述文字 |
| cancel `v3.0.10` | 自定义取消按钮内容 |
| 名称 | 说明 |
| ----------- | ------------------ |
| title | 自定义顶部标题 |
| description | 自定义描述文字 |
| cancel | 自定义取消按钮内容 |
### 类型定义

2
packages/vant/src/sidebar/README.md
View File

@ -107,7 +107,7 @@ export default {
| title | Content | _string_ | `''` |
| dot | Whether to show red dot | _boolean_ | `false` |
| badge | Content of the badge | _number \| string_ | `''` |
| badge-props `v3.2.8` | Props of Badge, see [Badge - props](#/en-US/badge#props) | _BadgeProps_ | - |
| badge-props | Props of Badge, see [Badge - props](#/en-US/badge#props) | _BadgeProps_ | - |
| disabled | Whether to be disabled | _boolean_ | `false` |
| url | Link | _string_ | - |
| to | Target route of the link, same as to of vue-router | _string \| object_ | - |

2
packages/vant/src/sidebar/README.zh-CN.md
View File

@ -115,7 +115,7 @@ export default {
| title | 内容 | _string_ | `''` |
| dot | 是否显示右上角小红点 | _boolean_ | `false` |
| badge | 图标右上角徽标的内容 | _number \| string_ | - |
| badge-props `v3.2.8` | 自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props) | _BadgeProps_ | - |
| badge-props | 自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props) | _BadgeProps_ | - |
| disabled | 是否禁用该项 | _boolean_ | `false` |
| url | 点击后跳转的链接地址 | _string_ | - |
| to | 点击后跳转的目标路由对象，等同于 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - |

14
packages/vant/src/slider/README.md
View File

@ -159,9 +159,9 @@ export default {
| active-color | Active color of bar | _string_ | `#1989fa` |
| inactive-color | Inactive color of bar | _string_ | `#e5e5e5` |
| range | Whether to enable dual thumb mode | _boolean_ | `false` |
| reverse `v3.2.1` | Whether to reverse slider | _boolean_ | `false` |
| reverse | Whether to reverse slider | _boolean_ | `false` |
| disabled | Whether to disable slider | _boolean_ | `false` |
| readonly `v3.0.5` | Whether to be readonly | _boolean_ | `false` |
| readonly | Whether to be readonly | _boolean_ | `false` |
| vertical | Whether to display slider vertically | _boolean_ | `false` |
### Events
@ -175,11 +175,11 @@ export default {
### Slots
| Name | Description | SlotProps |
| --- | --- | --- |
| button | Custom button | _{ value: number }_ |
| left-button `v3.1.3` | Custom left button in range mode | _{ value: number }_ |
| right-button `v3.1.3` | Custom right button in range mode | _{ value: number }_ |
| Name | Description | SlotProps |
| ------------ | --------------------------------- | ------------------- |
| button | Custom button | _{ value: number }_ |
| left-button | Custom left button in range mode | _{ value: number }_ |
| right-button | Custom right button in range mode | _{ value: number }_ |
### Types

14
packages/vant/src/slider/README.zh-CN.md
View File

@ -161,9 +161,9 @@ export default {
| active-color | 进度条激活态颜色 | _string_ | `#1989fa` |
| inactive-color | 进度条非激活态颜色 | _string_ | `#e5e5e5` |
| range | 是否开启双滑块模式 | _boolean_ | `false` |
| reverse `v3.2.1` | 是否将进度条反转 | _boolean_ | `false` |
| reverse | 是否将进度条反转 | _boolean_ | `false` |
| disabled | 是否禁用滑块 | _boolean_ | `false` |
| readonly `v3.0.5` | 是否为只读状态，只读状态下无法修改滑块的值 | _boolean_ | `false` |
| readonly | 是否为只读状态，只读状态下无法修改滑块的值 | _boolean_ | `false` |
| vertical | 是否垂直展示 | _boolean_ | `false` |
### Events
@ -177,11 +177,11 @@ export default {
### Slots
| 名称 | 说明 | 参数 |
| --- | --- | --- |
| button | 自定义滑块按钮 | _{ value: number }_ |
| left-button `v3.1.3` | 自定义左侧滑块按钮（双滑块模式下） | _{ value: number }_ |
| right-button `v3.1.3` | 自定义右侧滑块按钮（双滑块模式下） | _{ value: number }_ |
| 名称 | 说明 | 参数 |
| ------------ | ---------------------------------- | ------------------- |
| button | 自定义滑块按钮 | _{ value: number }_ |
| left-button | 自定义左侧滑块按钮（双滑块模式下） | _{ value: number }_ |
| right-button | 自定义右侧滑块按钮（双滑块模式下） | _{ value: number }_ |
### 类型定义

2
packages/vant/src/space/README.zh-CN.md
View File

@ -2,7 +2,7 @@
### 介绍
设置元素之间的间距，从 `v3.6.0` 版本开始支持。
设置元素之间的间距，从 版本开始支持。
### 引入

16
packages/vant/src/steps/README.md
View File

@ -83,17 +83,17 @@ export default {
| inactive-color | Inactive step color | _string_ | `#969799` |
| active-icon | Active icon name | _string_ | `checked` |
| inactive-icon | Inactive icon name | _string_ | - |
| finish-icon `v3.0.7` | Finish icon name | _string_ | - |
| icon-prefix `v3.0.15` | Icon className prefix | _string_ | `van-icon` |
| finish-icon | Finish icon name | _string_ | - |
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
### Step Slots
| Name | Description |
| -------------------- | -------------------- |
| default | Step content |
| active-icon | Custom active icon |
| inactive-icon | Custom inactive icon |
| finish-icon `v3.0.7` | Custom finish icon |
| Name | Description |
| ------------- | -------------------- |
| default | Step content |
| active-icon | Custom active icon |
| inactive-icon | Custom inactive icon |
| finish-icon | Custom finish icon |
### Steps Events

16
packages/vant/src/steps/README.zh-CN.md
View File

@ -87,19 +87,19 @@ export default {
| direction | 步骤条方向，可选值为 `vertical` | _string_ | `horizontal` |
| active-icon | 当前步骤对应的底部图标，可选值见 [Icon 组件](#/zh-CN/icon) | _string_ | `checked` |
| inactive-icon | 非当前步骤对应的底部图标，可选值见 [Icon 组件](#/zh-CN/icon) | _string_ | - |
| finish-icon `v3.0.7` | 已完成步骤对应的底部图标，优先级高于 `inactive-icon`，可选值见 [Icon 组件](#/zh-CN/icon) | _string_ | - |
| finish-icon | 已完成步骤对应的底部图标，优先级高于 `inactive-icon`，可选值见 [Icon 组件](#/zh-CN/icon) | _string_ | - |
| active-color | 当前步骤和已完成步骤的颜色 | _string_ | `#07c160` |
| inactive-color | 未激活步骤的颜色 | _string_ | `#969799` |
| icon-prefix `v3.0.15` | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| icon-prefix | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
### Step Slots
| 名称 | 说明 |
| --- | --- |
| default | 步骤内容 |
| active-icon | 自定义激活状态图标 |
| inactive-icon | 自定义未激活状态图标 |
| finish-icon `v3.0.7` | 自定义已完成步骤对应的底部图标，优先级高于 `inactive-icon` |
| 名称 | 说明 |
| ------------- | ---------------------------------------------------------- |
| default | 步骤内容 |
| active-icon | 自定义激活状态图标 |
| inactive-icon | 自定义未激活状态图标 |
| finish-icon | 自定义已完成步骤对应的底部图标，优先级高于 `inactive-icon` |
### Steps Events

6
packages/vant/src/sticky/README.md
View File

@ -67,9 +67,9 @@ export default {
| Attribute | Description | Type | Default |
| --- | --- | --- | --- |
| position `v3.0.6` | Offset position, can be set to `bottom` | _string_ | `top` |
| position | Offset position, can be set to `bottom` | _string_ | `top` |
| offset-top | Offset top, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `0` |
| offset-bottom `v3.0.6` | Offset bottom, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `0` |
| offset-bottom | Offset bottom, supports `px` `vw` `vh` `rem` unit, default `px` | _number \| string_ | `0` |
| z-index | z-index when sticky | _number \| string_ | `99` |
| container | Container DOM | _Element_ | - |
@ -77,7 +77,7 @@ export default {
| Event | Description | Arguments |
| --- | --- | --- |
| change `v3.0.10` | Emitted when sticky status changed | _isFixed: boolean_ |
| change | Emitted when sticky status changed | _isFixed: boolean_ |
| scroll | Emitted when scrolling | _{ scrollTop: number, isFixed: boolean }_ |
### Types

12
packages/vant/src/sticky/README.zh-CN.md
View File

@ -75,18 +75,18 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| position `v3.0.6` | 吸附位置，可选值为 `bottom` | _string_ | `top` |
| position | 吸附位置，可选值为 `bottom` | _string_ | `top` |
| offset-top | 吸顶时与顶部的距离，支持 `px` `vw` `vh` `rem` 单位，默认 `px` | _number \| string_ | `0` |
| offset-bottom `v3.0.6` | 吸底时与底部的距离，支持 `px` `vw` `vh` `rem` 单位，默认 `px` | _number \| string_ | `0` |
| offset-bottom | 吸底时与底部的距离，支持 `px` `vw` `vh` `rem` 单位，默认 `px` | _number \| string_ | `0` |
| z-index | 吸顶时的 z-index | _number \| string_ | `99` |
| container | 容器对应的 HTML 节点 | _Element_ | - |
### Events
| 事件名 | 说明 | 回调参数 |
| --- | --- | --- |
| change `v3.0.10` | 当吸顶状态改变时触发 | _isFixed: boolean_ |
| scroll | 滚动时触发 | _{ scrollTop: number, isFixed: boolean }_ |
| 事件名 | 说明 | 回调参数 |
| ------ | -------------------- | ----------------------------------------- |
| change | 当吸顶状态改变时触发 | _isFixed: boolean_ |
| scroll | 滚动时触发 | _{ scrollTop: number, isFixed: boolean }_ |
### 类型定义

2
packages/vant/src/submit-bar/README.md
View File

@ -106,7 +106,7 @@ export default {
| disabled | Whether to disable button | _boolean_ | `false` |
| loading | Whether to show loading icon | _boolean_ | `false` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` |
| placeholder `v3.5.1` | Whether to generate a placeholder element | _boolean_ | `false` |
| placeholder | Whether to generate a placeholder element | _boolean_ | `false` |
### Events

2
packages/vant/src/submit-bar/README.zh-CN.md
View File

@ -113,7 +113,7 @@ export default {
| disabled | 是否禁用按钮 | _boolean_ | `false` |
| loading | 是否显示将按钮显示为加载中状态 | _boolean_ | `false` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `true` |
| placeholder `v3.5.1` | 是否在标签位置生成一个等高的占位元素 | _boolean_ | `false` |
| placeholder | 是否在标签位置生成一个等高的占位元素 | _boolean_ | `false` |
### Events

8
packages/vant/src/swipe/README.md
View File

@ -208,10 +208,10 @@ swipeRef.value?.next();
### Swipe Slots
| Name | Description | SlotProps |
| ------------------ | ---------------- | ----------------------------------- |
| default | Content | - |
| indicator `v3.4.0` | Custom indicator | _{ active: number, total: number }_ |
| Name | Description | SlotProps |
| --------- | ---------------- | ----------------------------------- |
| default | Content | - |
| indicator | Custom indicator | _{ active: number, total: number }_ |
## Theming

8
packages/vant/src/swipe/README.zh-CN.md
View File

@ -216,10 +216,10 @@ swipeRef.value?.next();
### Swipe Slots
| 名称 | 说明 | 参数 |
| ------------------ | ------------ | ----------------------------------- |
| default | 轮播内容 | - |
| indicator `v3.4.0` | 自定义指示器 | _{ active: number, total: number }_ |
| 名称 | 说明 | 参数 |
| --------- | ------------ | ----------------------------------- |
| default | 轮播内容 | - |
| indicator | 自定义指示器 | _{ active: number, total: number }_ |
## 主题定制

8
packages/vant/src/switch/README.md
View File

@ -156,10 +156,10 @@ export default {
### Slots
| Name | Description | SlotProps |
| ------------------- | ------------------------------- | --------- |
| node `v3.5.0` | Custom the content of node | - |
| background `v3.5.0` | Custom the background of switch | - |
| Name | Description | SlotProps |
| ---------- | ------------------------------- | --------- |
| node | Custom the content of node | - |
| background | Custom the background of switch | - |
### Types

8
packages/vant/src/switch/README.zh-CN.md
View File

@ -168,10 +168,10 @@ export default {
### Slots
| 名称 | 说明 | 参数 |
| ------------------- | -------------------- | ---- |
| node `v3.5.0` | 自定义按钮的内容 | - |
| background `v3.5.0` | 自定义开关的背景内容 | - |
| 名称 | 说明 | 参数 |
| ---------- | -------------------- | ---- |
| node | 自定义按钮的内容 | - |
| background | 自定义开关的背景内容 | - |
### 类型定义

16
packages/vant/src/tab/README.md
View File

@ -248,7 +248,7 @@ export default {
| border | Whether to show border when `type="line"` | _boolean_ | `false` |
| ellipsis | Whether to ellipsis too long title | _boolean_ | `true` |
| sticky | Whether to use sticky mode | _boolean_ | `false` |
| shrink `v3.2.8` | Whether to shrink the the tabs to the left | _boolean_ | `false` |
| shrink | Whether to shrink the the tabs to the left | _boolean_ | `false` |
| swipeable | Whether to enable gestures to slide left and right | _boolean_ | `false` |
| lazy-render | Whether to enable tab content lazy render | _boolean_ | `true` |
| scrollspy | Whether to use scrollspy mode | _boolean_ | `false` |
@ -272,13 +272,13 @@ export default {
| replace | If true, the navigation will not leave a history record | _boolean_ | `false` |
| title-style | Custom title style | _string \| Array \| object_ | - |
| title-class | Custom title class name | _string \| Array \| object_ | - |
| show-zero-badge `v3.2.2` | Whether to show badge when the value is zero | _boolean_ | `true` |
| show-zero-badge | Whether to show badge when the value is zero | _boolean_ | `true` |
### Tabs Events
| Event | Description | Arguments |
| --- | --- | --- |
| click-tab `v3.1.4` | Emitted when a tab is clicked | _{ name: string \| number, title: string, event: MouseEvent, disabled: boolean }_ |
| click-tab | Emitted when a tab is clicked | _{ name: string \| number, title: string, event: MouseEvent, disabled: boolean }_ |
| change | Emitted when active tab changed | _name: string \| number, title: string_ |
| rendered | Emitted when content first rendered in lazy-render mode | _name: string \| number, title: string_ |
| scroll | Emitted when tab scrolling in sticky mode | _{ scrollTop: number, isFixed: boolean }_ |
@ -313,11 +313,11 @@ tabsRef.value?.scrollTo(0);
### Tabs Slots
| Name | Description |
| ------------------- | ------------------------- |
| nav-left | Custom nav left content |
| nav-right | Custom nav right content |
| nav-bottom `v3.1.1` | Custom nav bottom content |
| Name | Description |
| ---------- | ------------------------- |
| nav-left | Custom nav left content |
| nav-right | Custom nav right content |
| nav-bottom | Custom nav bottom content |
### Tab Slots

16
packages/vant/src/tab/README.zh-CN.md
View File

@ -261,7 +261,7 @@ export default {
| border | 是否显示标签栏外边框，仅在 `type="line"` 时有效 | _boolean_ | `false` |
| ellipsis | 是否省略过长的标题文字 | _boolean_ | `true` |
| sticky | 是否使用粘性布局 | _boolean_ | `false` |
| shrink `v3.2.8` | 是否开启左侧收缩布局 | _boolean_ | `false` |
| shrink | 是否开启左侧收缩布局 | _boolean_ | `false` |
| swipeable | 是否开启手势左右滑动切换 | _boolean_ | `false` |
| lazy-render | 是否开启延迟渲染（首次切换到标签时才触发内容渲染） | _boolean_ | `true` |
| scrollspy | 是否开启滚动导航 | _boolean_ | `false` |
@ -285,13 +285,13 @@ export default {
| replace | 是否在跳转时替换当前页面历史 | _boolean_ | `false` |
| title-style | 自定义标题样式 | _string \| Array \| object_ | - |
| title-class | 自定义标题类名 | _string \| Array \| object_ | - |
| show-zero-badge `v3.2.2` | 当 badge 为数字 0 时，是否展示徽标 | _boolean_ | `true` |
| show-zero-badge | 当 badge 为数字 0 时，是否展示徽标 | _boolean_ | `true` |
### Tabs Events
| 事件名 | 说明 | 回调参数 |
| --- | --- | --- |
| click-tab `v3.1.4` | 点击标签时触发 | _{ name: string \| number, title: string, event: MouseEvent, disabled: boolean }_ |
| click-tab | 点击标签时触发 | _{ name: string \| number, title: string, event: MouseEvent, disabled: boolean }_ |
| change | 当前激活的标签改变时触发 | _name: string \| number, title: string_ |
| rendered | 标签内容首次渲染时触发（仅在开启延迟渲染后触发） | _name: string \| number, title: string_ |
| scroll | 滚动时触发，仅在 sticky 模式下生效 | _{ scrollTop: number, isFixed: boolean }_ |
@ -328,11 +328,11 @@ tabsRef.value?.scrollTo(0);
### Tabs Slots
| 名称 | 说明 |
| ------------------- | -------------- |
| nav-left | 标签栏左侧内容 |
| nav-right | 标签栏右侧内容 |
| nav-bottom `v3.1.1` | 标签栏下方内容 |
| 名称 | 说明 |
| ---------- | -------------- |
| nav-left | 标签栏左侧内容 |
| nav-right | 标签栏右侧内容 |
| nav-bottom | 标签栏下方内容 |
### Tab Slots

2
packages/vant/src/tabbar/README.md
View File

@ -191,7 +191,7 @@ export default {
| icon-prefix | Icon className prefix | _string_ | `van-icon` |
| dot | Whether to show red dot | _boolean_ | - |
| badge | Content of the badge | _number \| string_ | `''` |
| badge-props `v3.2.8` | Props of Badge, see [Badge - props](#/en-US/badge#props) | _BadgeProps_ | - |
| badge-props | Props of Badge, see [Badge - props](#/en-US/badge#props) | _BadgeProps_ | - |
| url | Link | _string_ | - |
| to | Target route of the link, same as to of vue-router | _string \| object_ | - |
| replace | If true, the navigation will not leave a history record | _boolean_ | `false` |

2
packages/vant/src/tabbar/README.zh-CN.md
View File

@ -203,7 +203,7 @@ export default {
| icon-prefix | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
| dot | 是否显示图标右上角小红点 | _boolean_ | `false` |
| badge | 图标右上角徽标的内容 | _number \| string_ | - |
| badge-props `v3.2.8` | 自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props) | _BadgeProps_ | - |
| badge-props | 自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props) | _BadgeProps_ | - |
| url | 点击后跳转的链接地址 | _string_ | - |
| to | 点击后跳转的目标路由对象，等同于 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - |
| replace | 是否在跳转时替换当前页面历史 | _boolean_ | `false` |

4
packages/vant/src/toast/README.md
View File

@ -228,8 +228,8 @@ Vant exports following Toast utility functions:
| loadingType | Loading icon type, can be set to `spinner` | _string_ | `circular` |
| duration | Toast duration(ms), won't disappear if value is 0 | _number_ | `2000` |
| className | Custom className | _string \| Array \| object_ | - |
| overlayClass `v3.0.4` | Custom overlay class | _string \| Array \| object_ | - |
| overlayStyle `v3.0.4` | Custom overlay style | _object_ | - |
| overlayClass | Custom overlay class | _string \| Array \| object_ | - |
| overlayStyle | Custom overlay style | _object_ | - |
| onOpened | Callback function after opened | _Function_ | - |
| onClose | Callback function after close | _Function_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |

4
packages/vant/src/toast/README.zh-CN.md
View File

@ -247,8 +247,8 @@ Vant 中导出了以下 Toast 相关的辅助函数：
| loadingType | [加载图标类型](#/zh-CN/loading), 可选值为 `spinner` | _string_ | `circular` |
| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | _number_ | `2000` |
| className | 自定义类名 | _string \| Array \| object_ | - |
| overlayClass `v3.0.4` | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlayStyle `v3.0.4` | 自定义遮罩层样式 | _object_ | - |
| overlayClass | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlayStyle | 自定义遮罩层样式 | _object_ | - |
| onOpened | 完全展示后的回调函数 | _Function_ | - |
| onClose | 关闭时的回调函数 | _Function_ | - |
| transition | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的`name`属性 | _string_ | `van-fade` |

6
packages/vant/src/uploader/README.md
View File

@ -313,7 +313,7 @@ export default {
| preview-options | Options of full screen image preview, see [ImagePreview](#/en-US/image-preview) | _object_ | - |
| multiple | Whether to enable multiple selection pictures | _boolean_ | `false` |
| disabled | Whether to disabled the upload | _boolean_ | `false` |
| readonly `v3.1.5` | Whether to make upload area readonly | _boolean_ | `false` |
| readonly | Whether to make upload area readonly | _boolean_ | `false` |
| deletable | Whether to show delete icon | _boolean_ | `true` |
| show-upload | Whether to show upload area | _boolean_ | `true` |
| lazy-load | Whether to enable lazy load, should register [Lazyload](#/en-US/lazyload) component | _boolean_ | `false` |
@ -321,7 +321,7 @@ export default {
| after-read | Hook after reading the file | _Function_ | - |
| before-read | Hook before reading the file, return false to stop reading the file, can return Promise | _Function_ | - |
| before-delete | Hook before delete the file, return false to stop reading the file, can return Promise | _Function_ | - |
| max-size `v3.0.17` | Max size of file | _number \| string \| (file: File) => boolean_ | `Infinity` |
| max-size | Max size of file | _number \| string \| (file: File) => boolean_ | `Infinity` |
| max-count | Max count of image | _number \| string_ | `Infinity` |
| result-type | Type of file read result, can be set to `file` `text` | _string_ | `dataUrl` |
| upload-text | Upload text | _string_ | - |
@ -335,7 +335,7 @@ export default {
| Event | Description | Arguments |
| --- | --- | --- |
| oversize | Emitted when file size over limit | Same as after-read |
| click-upload `v3.1.5` | Emitted when click upload area | _event: MouseEvent_ |
| click-upload | Emitted when click upload area | _event: MouseEvent_ |
| click-preview | Emitted when preview image is clicked | Same as after-read |
| close-preview | Emitted when the full screen image preview is closed | - |
| delete | Emitted when preview file is deleted | Same as after-read |

28
packages/vant/src/uploader/README.zh-CN.md
View File

@ -332,7 +332,7 @@ export default {
| preview-options | 全屏图片预览的配置项，可选值见 [ImagePreview](#/zh-CN/image-preview) | _object_ | - |
| multiple | 是否开启图片多选，部分安卓机型不支持 | _boolean_ | `false` |
| disabled | 是否禁用文件上传 | _boolean_ | `false` |
| readonly `v3.1.5` | 是否将上传区域设置为只读状态 | _boolean_ | `false` |
| readonly | 是否将上传区域设置为只读状态 | _boolean_ | `false` |
| deletable | 是否展示删除按钮 | _boolean_ | `true` |
| show-upload | 是否展示上传区域 | _boolean_ | `true` |
| lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | _boolean_ | `false` |
@ -340,7 +340,7 @@ export default {
| after-read | 文件读取完成后的回调函数 | _Function_ | - |
| before-read | 文件读取前的回调函数，返回 `false` 可终止文件读取，<br>支持返回 `Promise` | _Function_ | - |
| before-delete | 文件删除前的回调函数，返回 `false` 可终止文件读取，<br>支持返回 `Promise` | _Function_ | - |
| max-size `v3.0.17` | 文件大小限制，单位为 `byte` | _number \| string \| (file: File) => boolean_ | `Infinity` |
| max-size | 文件大小限制，单位为 `byte` | _number \| string \| (file: File) => boolean_ | `Infinity` |
| max-count | 文件上传数量限制 | _number \| string_ | `Infinity` |
| result-type | 文件读取结果类型，可选值为 `file` `text` | _string_ | `dataUrl` |
| upload-text | 上传区域文字提示 | _string_ | - |
@ -351,21 +351,21 @@ export default {
### Events
| 事件名 | 说明 | 回调参数 |
| --------------------- | ---------------------- | ------------------- |
| oversize | 文件大小超过限制时触发 | 同 `after-read` |
| click-upload `v3.1.5` | 点击上传区域时触发 | _event: MouseEvent_ |
| click-preview | 点击预览图时触发 | 同 `after-read` |
| close-preview | 关闭全屏图片预览时触发 | - |
| delete | 删除文件预览时触发 | 同 `after-read` |
| 事件名 | 说明 | 回调参数 |
| ------------- | ---------------------- | ------------------- |
| oversize | 文件大小超过限制时触发 | 同 `after-read` |
| click-upload | 点击上传区域时触发 | _event: MouseEvent_ |
| click-preview | 点击预览图时触发 | 同 `after-read` |
| close-preview | 关闭全屏图片预览时触发 | - |
| delete | 删除文件预览时触发 | 同 `after-read` |
### Slots
| 名称 | 说明 | 参数 |
| --- | --- | --- |
| default | 自定义上传区域 | - |
| preview-delete `v3.5.0` | 自定义删除按钮 | - |
| preview-cover | 自定义覆盖在预览区域上方的内容 | _item: FileListItem_ |
| 名称 | 说明 | 参数 |
| -------------- | ------------------------------ | -------------------- |
| default | 自定义上传区域 | - |
| preview-delete | 自定义删除按钮 | - |
| preview-cover | 自定义覆盖在预览区域上方的内容 | _item: FileListItem_ |
### 回调参数