blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-05 19:41:42 +08:00
Code Issues Projects Releases Wiki Activity

docs: update Vue document URLs (#11989)

Browse Source
This commit is contained in:
neverland 2023-06-17 09:46:38 +08:00 committed by GitHub
parent d42adccfb0
commit 8320eb1e16
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
37 changed files with 52 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/vant/docs/markdown/advanced-usage.en-US.md
View File

@ -37,7 +37,7 @@ export default {
};
```
> For more information, please refer to [Vue.js - Component Registration](https://v3.vuejs.org/guide/component-registration.html#component-registration)。
> For more information, please refer to [Vue.js - Component Registration](https://vuejs.org/guide/components/registration.html)。
#### \<script setup\>

6
packages/vant/docs/markdown/advanced-usage.zh-CN.md
View File

@ -43,7 +43,7 @@ export default {
};
```
> 对于组件注册更详细的介绍，请参考 [Vue 官方文档 - 组件注册](https://v3.cn.vuejs.org/guide/component-registration.html#%E7%BB%84%E4%BB%B6%E6%B3%A8%E5%86%8C)。
> 对于组件注册更详细的介绍，请参考 [Vue 官方文档 - 组件注册](https://cn.vuejs.org/guide/components/registration.html)。
#### \<script setup\>
@ -75,7 +75,7 @@ export default {
### 组件插槽
Vant 提供了丰富的组件插槽，通过插槽可以对组件的某一部分进行个性化定制。如果你对 Vue 的插槽不太熟悉，可以阅读 Vue 官方文档中的[插槽章节](https://v3.cn.vuejs.org/guide/component-slots.html)。下面是通过插槽来定制 Checkbox 图标的示例：
Vant 提供了丰富的组件插槽，通过插槽可以对组件的某一部分进行个性化定制。如果你对 Vue 的插槽不太熟悉，可以阅读 Vue 官方文档中的[插槽章节](https://cn.vuejs.org/guide/components/slots.html)。下面是通过插槽来定制 Checkbox 图标的示例：
```html
<van-checkbox v-model="checked">
@ -103,7 +103,7 @@ export default {
### 组件实例方法
Vant 中的许多组件提供了实例方法，调用实例方法时，我们需要通过 [ref](https://v3.cn.vuejs.org/guide/component-template-refs.html) 来注册组件引用信息，引用信息将会注册在父组件的`$refs`对象上。注册完成后，我们可以通过`this.$refs.xxx`访问到对应的组件实例，并调用上面的实例方法。
Vant 中的许多组件提供了实例方法，调用实例方法时，我们需要通过 [ref](https://cn.vuejs.org/guide/essentials/template-refs.html) 来注册组件引用信息，引用信息将会注册在父组件的`$refs`对象上。注册完成后，我们可以通过`this.$refs.xxx`访问到对应的组件实例，并调用上面的实例方法。
```html
<!-- 通过 ref 属性将组件绑定到 this.$refs.checkbox 上 -->

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

@ -200,7 +200,7 @@ export default {
| close-on-click-action | 是否在点击选项后关闭 | _boolean_ | `false` |
| 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_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
| before-close | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(action: string) => boolean \| Promise\<boolean\>_ | - |
### Action 数据结构

2
packages/vant/src/address-edit/README.md
View File

@ -116,7 +116,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get AddressEdit instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get AddressEdit instance and call instance methods.
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |

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

@ -154,7 +154,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Area instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Area instance and call instance methods.
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |

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

@ -126,7 +126,7 @@ export default {
| right | 距离页面右侧的距离，默认单位为 `px` | _number \| string_ | `30` |
| bottom | 距离页面底部的距离，默认单位为 `px` | _number \| string_ | `40` |
| offset | 滚动高度达到此参数值时才显示组件 | _number_ | `200` |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | `body` |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | `body` |
| immediate `v4.0.9` | 是否瞬间滚动到顶部 | _boolean_ | `false` |
| z-index | 设置组件的 z-index 层级 | _number \| string_ | `100` |

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

@ -113,7 +113,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Barrage instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Barrage instance and call instance methods.
| Name | Description | Attribute | Return value |
| ----- | ------------- | --------- | ------------ |

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

@ -343,7 +343,7 @@ Following props are supported when the type is multiple
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Calendar instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Calendar instance and call instance methods.
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |

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

@ -285,7 +285,7 @@ export default {
| close-on-click-overlay | 是否在点击遮罩层后关闭 | _boolean_ | `true` |
| safe-area-inset-top | 是否开启[顶部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `false` |
| 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_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
### Calendar Range Props

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

@ -300,7 +300,7 @@ export default {
### CheckboxGroup Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get CheckboxGroup instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get CheckboxGroup instance and call instance methods.
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |
@ -334,7 +334,7 @@ checkboxGroup.value?.toggleAll({
### Checkbox Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Checkbox instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Checkbox instance and call instance methods.
| Name | Description | Attribute | Return value |
| ------ | ------------------- | ------------------- | ------------ |

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

@ -187,7 +187,7 @@ export default {
### Collapse Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Collapse instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Collapse instance and call instance methods.
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |
@ -221,7 +221,7 @@ collapseRef.value?.toggleAll({
### CollapseItem Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get CollapseItem instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get CollapseItem instance and call instance methods.
| Name | Description | Attribute | Return value |
| ------ | ---------------------- | ------------------- | ------------ |

2
packages/vant/src/count-down/README.md
View File

@ -173,7 +173,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get CountDown instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get CountDown instance and call instance methods.
| Name | Description | Attribute | Return value |
| ----- | ---------------- | --------- | ------------ |

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

@ -165,7 +165,7 @@ Vant exports following Dialog utility functions:
| lockScroll | Whether to lock body scroll | _boolean_ | `true` |
| allowHtml | Whether to allow HTML rendering in message | _boolean_ | `false` |
| beforeClose | Callback function before close | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://vuejs.org/api/built-in-components.html#transition) | _string_ | - |
| teleport | Specifies a target element where Dialog will be mounted | _string \| Element_ | `body` |
### Props
@ -196,7 +196,7 @@ Vant exports following Dialog utility functions:
| lock-scroll | Whether to lock background scroll | _boolean_ | `true` |
| allow-html | Whether to allow HTML rendering in message | _boolean_ | `false` |
| before-close | Callback function before close | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://vuejs.org/api/built-in-components.html#transition) | _string_ | - |
| teleport | Specifies a target element where Dialog will be mounted | _string \| Element_ | - |
### Events

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

@ -184,8 +184,8 @@ Vant 中导出了以下 Dialog 相关的辅助函数：
| lockScroll | 是否锁定背景滚动 | _boolean_ | `true` |
| allowHtml | 是否允许 message 内容中渲染 HTML | _boolean_ | `false` |
| beforeClose | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| transition | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | `body` |
| transition | 动画类名，等价于 [transition](https://cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | `body` |
### Props
@ -217,8 +217,8 @@ Vant 中导出了以下 Dialog 相关的辅助函数：
| lock-scroll | 是否锁定背景滚动 | _boolean_ | `true` |
| allow-html | 是否允许 message 内容中渲染 HTML | _boolean_ | `false` |
| before-close | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(action: string) => boolean \| Promise\<boolean\>_ | - |
| transition | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
| transition | 动画类名，等价于 [transition](https://cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
### Events

4
packages/vant/src/dropdown-menu/README.md
View File

@ -189,7 +189,7 @@ Use `active-color` prop to custom active color of the title and options.
### DropdownMenu Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get DropdownMenu instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get DropdownMenu instance and call instance methods.
| Name | Description | Attribute | Return value |
| ----- | ------------------------ | --------- | ------------ |
@ -197,7 +197,7 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Dropdo
### DropdownItem Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get DropdownItem instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get DropdownItem instance and call instance methods.
| Name | Description | Attribute | Return value |
| ------ | -------------- | ---------------- | ------------ |

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

@ -172,7 +172,7 @@ export default {
| disabled | 是否禁用菜单 | _boolean_ | `false` |
| lazy-render | 是否在首次展开时才渲染菜单内容 | _boolean_ | `true` |
| title-class | 标题额外类名 | _string \| Array \| object_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
### DropdownItem Events

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

@ -336,7 +336,7 @@ Use `label-align` prop to align the input value, can be set to `center`, `right`
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Field instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Field instance and call instance methods.
| Name | Description | Attribute | Return value |
| ----- | ------------------- | --------- | ------------ |

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

@ -534,7 +534,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Form instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Form instance and call instance methods.
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |

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

@ -202,7 +202,7 @@ 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 | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |
| transition | Transition, equivalent to `name` prop of [transition](https://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_ | - |
@ -226,7 +226,7 @@ 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 | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |
| transition | Transition, equivalent to `name` prop of [transition](https://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_ | - |

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

@ -215,10 +215,10 @@ Vant 中导出了以下 ImagePreview 相关的辅助函数：
| closeable | 是否显示关闭图标 | _boolean_ | `false` |
| closeIcon | 关闭图标名称或图片链接 | _string_ | `clear` |
| closeIconPosition | 关闭图标位置，可选值为 `top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` |
| transition | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | `van-fade` |
| transition | 动画类名，等价于 [transition](https://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_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
### Props
@ -241,10 +241,10 @@ Vant 中导出了以下 ImagePreview 相关的辅助函数：
| closeable | 是否显示关闭图标 | _boolean_ | `false` |
| close-icon | 关闭图标名称或图片链接 | _string_ | `clear` |
| close-icon-position | 关闭图标位置，可选值为 `top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` |
| transition | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性 | _string_ | `van-fade` |
| transition | 动画类名，等价于 [transition](https://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_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
### Events

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

@ -93,7 +93,7 @@ export default {
### IndexBar Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get IndexBar instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get IndexBar instance and call instance methods.
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |

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

@ -186,7 +186,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get List instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get List instance and call instance methods.
| Name | Description | Attribute | Return value |
| ----- | --------------------- | --------- | ------------ |

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

@ -115,7 +115,7 @@ app.use(NoticeBar);
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get NoticeBar instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get NoticeBar instance and call instance methods.
| Name | Description | Attribute | Return value |
| ----- | --------------- | --------- | ------------ |

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

@ -189,7 +189,7 @@ export default {
| show-delete-key | 是否展示删除图标 | _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_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://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` |
| random-key-order | 是否将通过随机顺序展示按键 | _boolean_ | `false` |

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

@ -385,7 +385,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Picker instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Picker instance and call instance methods.
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |

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

@ -306,7 +306,7 @@ export default {
| close-on-click-action | 是否在点击选项后关闭 | _boolean_ | `true` |
| close-on-click-outside | 是否在点击外部元素后关闭菜单 | _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` |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | `body` |
| icon-prefix | 图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
### PopoverAction 数据结构

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

@ -235,7 +235,7 @@ Use `teleport` prop to specify mount location.
| close-icon-position | Close Icon Position, can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| 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 | Transition, equivalent to `name` prop of [transition](https://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_ | - |
| safe-area-inset-top | Whether to enable top safe area adaptation | _boolean_ | `false` |

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

@ -237,9 +237,9 @@ export default {
| close-icon-position | 关闭图标位置，可选值为 `top-left`<br>`bottom-left` `bottom-right` | _string_ | `top-right` |
| 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 | 动画类名，等价于 [transition](https://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_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
| safe-area-inset-top | 是否开启[顶部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `false` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | _boolean_ | `false` |

2
packages/vant/src/rolling-text/README.md
View File

@ -169,7 +169,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get RollingText instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get RollingText instance and call instance methods.
| Name | Description | Attribute | Return value |
| ----- | ------------------- | --------- | ------------ |

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

@ -177,7 +177,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Search instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Search instance and call instance methods.
| Name | Description | Attribute | Return value |
| ----- | ------------------- | --------- | ------------ |

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

@ -196,7 +196,7 @@ export default {
| close-on-popstate | 是否在页面回退时自动关闭 | _boolean_ | `true` |
| 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_ | - |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | - |
| before-close | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(action: string) => boolean \| Promise\<boolean\>_ | - |
### Option 数据结构

2
packages/vant/src/swipe-cell/README.md
View File

@ -139,7 +139,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get SwipeCell instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get SwipeCell instance and call instance methods.
| Name | Description | Attribute | Return value |
| ----- | --------------- | ------------------------- | ------------ |

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

@ -172,7 +172,7 @@ export default {
### Swipe Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Swipe instance and call instance methods..
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Swipe instance and call instance methods..
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |

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

@ -285,7 +285,7 @@ export default {
### Tabs Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Tabs instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Tabs instance and call instance methods.
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |

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

@ -232,7 +232,7 @@ Vant exports following Toast utility functions:
| 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` |
| transition | Transition, equivalent to `name` prop of [transition](https://vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |
| teleport | Specifies a target element where Toast will be mounted | _string \| Element_ | `body` |
### Slots

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

@ -251,8 +251,8 @@ Vant 中导出了以下 Toast 相关的辅助函数：
| overlayStyle | 自定义遮罩层样式 | _object_ | - |
| onOpened | 完全展示后的回调函数 | _Function_ | - |
| onClose | 关闭时的回调函数 | _Function_ | - |
| transition | 动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的`name`属性 | _string_ | `van-fade` |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://v3.cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | `body` |
| transition | 动画类名，等价于 [transition](https://cn.vuejs.org/api/built-in-components.html#transition) 的`name`属性 | _string_ | `van-fade` |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 [to 属性](https://cn.vuejs.org/api/built-in-components.html#teleport) | _string \| Element_ | `body` |
### Slots

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

@ -387,7 +387,7 @@ export default {
### Methods
Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Uploader instance and call instance methods.
Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Uploader instance and call instance methods.
| Name | Description | Attribute | Return value |
| --- | --- | --- | --- |