From e3cb465dc2e0f899e08f9026ffc8aba580d2897e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=99=88=E5=98=89=E6=B6=B5?= Date: Fri, 3 May 2019 09:37:24 +0800 Subject: [PATCH] [Doc] props title --- packages/action-sheet/en-US.md | 4 ++-- packages/action-sheet/zh-CN.md | 6 +++--- packages/address-edit/en-US.md | 6 +++--- packages/address-edit/zh-CN.md | 6 +++--- packages/address-list/en-US.md | 6 +++--- packages/address-list/zh-CN.md | 6 +++--- packages/area/en-US.md | 4 ++-- packages/area/zh-CN.md | 4 ++-- packages/button/en-US.md | 4 ++-- packages/button/zh-CN.md | 4 ++-- packages/card/en-US.md | 6 +++--- packages/card/zh-CN.md | 6 +++--- packages/cell/en-US.md | 8 ++++---- packages/cell/zh-CN.md | 8 ++++---- packages/checkbox/en-US.md | 10 +++++----- packages/checkbox/zh-CN.md | 10 +++++----- packages/circle/en-US.md | 4 ++-- packages/circle/zh-CN.md | 4 ++-- packages/col/en-US.md | 6 ++---- packages/col/zh-CN.md | 6 ++---- packages/collapse/en-US.md | 8 ++++---- packages/collapse/zh-CN.md | 8 ++++---- packages/contact-card/en-US.md | 12 ++++++------ packages/contact-card/zh-CN.md | 12 ++++++------ packages/coupon-list/en-US.md | 6 +++--- packages/coupon-list/zh-CN.md | 6 +++--- packages/datetime-picker/en-US.md | 4 ++-- packages/datetime-picker/zh-CN.md | 4 ++-- packages/dialog/en-US.md | 4 ++-- packages/dialog/zh-CN.md | 6 +++--- packages/field/en-US.md | 6 +++--- packages/field/zh-CN.md | 6 +++--- packages/goods-action/en-US.md | 2 +- packages/goods-action/zh-CN.md | 2 +- packages/icon/en-US.md | 4 ++-- packages/icon/zh-CN.md | 4 ++-- packages/image-preview/en-US.md | 4 ++-- packages/image-preview/zh-CN.md | 8 ++++---- packages/list/en-US.md | 6 +++--- packages/list/zh-CN.md | 6 +++--- packages/loading/en-US.md | 4 ++-- packages/loading/zh-CN.md | 4 ++-- packages/nav-bar/en-US.md | 6 +++--- packages/nav-bar/zh-CN.md | 6 +++--- packages/notice-bar/en-US.md | 6 +++--- packages/notice-bar/zh-CN.md | 6 +++--- packages/notify/en-US.md | 2 +- packages/number-keyboard/en-US.md | 6 +++--- packages/number-keyboard/zh-CN.md | 6 +++--- packages/pagination/en-US.md | 4 ++-- packages/pagination/zh-CN.md | 4 ++-- packages/panel/en-US.md | 4 ++-- packages/panel/zh-CN.md | 4 ++-- packages/password-input/en-US.md | 4 ++-- packages/password-input/zh-CN.md | 4 ++-- packages/picker/en-US.md | 6 +++--- packages/picker/zh-CN.md | 6 +++--- packages/popup/en-US.md | 4 ++-- packages/popup/zh-CN.md | 4 ++-- packages/progress/en-US.md | 2 +- packages/progress/zh-CN.md | 2 +- packages/pull-refresh/en-US.md | 6 +++--- packages/pull-refresh/zh-CN.md | 6 +++--- packages/radio/en-US.md | 10 +++++----- packages/radio/zh-CN.md | 10 +++++----- packages/rate/en-US.md | 4 ++-- packages/rate/zh-CN.md | 4 ++-- packages/search/en-US.md | 6 +++--- packages/search/zh-CN.md | 6 +++--- packages/sidebar/en-US.md | 8 ++++---- packages/sidebar/zh-CN.md | 8 ++++---- packages/skeleton/en-US.md | 2 +- packages/skeleton/zh-CN.md | 2 +- packages/sku/en-US.md | 8 ++++---- packages/sku/zh-CN.md | 6 +++--- packages/slider/en-US.md | 6 +++--- packages/slider/zh-CN.md | 6 +++--- packages/stepper/en-US.md | 4 ++-- packages/stepper/zh-CN.md | 4 ++-- packages/steps/en-US.md | 4 ++-- packages/steps/zh-CN.md | 4 ++-- packages/submit-bar/en-US.md | 6 +++--- packages/submit-bar/zh-CN.md | 6 +++--- packages/swipe-cell/en-US.md | 6 +++--- packages/swipe-cell/zh-CN.md | 6 +++--- packages/swipe/en-US.md | 6 +++--- packages/swipe/zh-CN.md | 4 ++-- packages/switch-cell/en-US.md | 4 ++-- packages/switch-cell/zh-CN.md | 4 ++-- packages/switch/en-US.md | 4 ++-- packages/switch/zh-CN.md | 4 ++-- packages/tab/en-US.md | 10 +++++----- packages/tab/zh-CN.md | 10 +++++----- packages/tabbar/en-US.md | 8 ++++---- packages/tabbar/zh-CN.md | 8 ++++---- packages/tag/en-US.md | 6 +++--- packages/tag/zh-CN.md | 6 +++--- packages/tree-select/en-US.md | 6 +++--- packages/tree-select/zh-CN.md | 2 +- packages/uploader/en-US.md | 6 +++--- packages/uploader/zh-CN.md | 6 +++--- 101 files changed, 279 insertions(+), 283 deletions(-) diff --git a/packages/action-sheet/en-US.md b/packages/action-sheet/en-US.md index 3ef996421..594d96140 100644 --- a/packages/action-sheet/en-US.md +++ b/packages/action-sheet/en-US.md @@ -74,7 +74,7 @@ ActionSheet will get another style if there is a `title` prop. ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -87,7 +87,7 @@ ActionSheet will get another style if there is a `title` prop. | get-container | Return the mount node for action-sheet | `String | () => HTMLElement` | - | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | `Boolean` | `false` | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/action-sheet/zh-CN.md b/packages/action-sheet/zh-CN.md index 58f079590..04c47c1ef 100644 --- a/packages/action-sheet/zh-CN.md +++ b/packages/action-sheet/zh-CN.md @@ -79,7 +79,7 @@ export default { ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -92,7 +92,7 @@ export default { | get-container | 指定挂载的节点，可以传入选择器，
或一个返回节点的函数 | `String | () => HTMLElement` | - | - | | safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `Boolean` | `false` | 1.6.15 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| @@ -101,7 +101,7 @@ export default { ### actions -`API`中的`actions`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key`： +`Props`中的`actions`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key`： | key | 说明 | |------|------| diff --git a/packages/address-edit/en-US.md b/packages/address-edit/en-US.md index 4155b9035..97e730d10 100644 --- a/packages/address-edit/en-US.md +++ b/packages/address-edit/en-US.md @@ -57,7 +57,7 @@ export default { ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -75,7 +75,7 @@ export default { | tel-validator | The method to validate tel | `(tel: string) => boolean` | - | | validator | Custom validator | `(key, value) => string` | - | 1.3.9 | -### Event +### Events | Event | Description | Arguments | |------|------|------| @@ -88,7 +88,7 @@ export default { | change-detail | Triggered when address detail changed | value: address detail | | change-default | Triggered when switch default address | value: checked | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/address-edit/zh-CN.md b/packages/address-edit/zh-CN.md index ad61b793f..571ae87bb 100644 --- a/packages/address-edit/zh-CN.md +++ b/packages/address-edit/zh-CN.md @@ -55,7 +55,7 @@ export default { } ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -73,7 +73,7 @@ export default { | tel-validator | 手机号格式校验函数 | `string => boolean` | - | - | | validator | 自定义校验函数 | `(key, value) => string` | - | 1.3.9 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| @@ -86,7 +86,7 @@ export default { | change-detail | 修改详细地址时触发 | value: 详细地址内容 | | change-default | 切换是否使用默认地址时触发 | value: 是否选中 | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/address-list/en-US.md b/packages/address-list/en-US.md index 4cf7da85b..6e48f5a77 100644 --- a/packages/address-list/en-US.md +++ b/packages/address-list/en-US.md @@ -63,7 +63,7 @@ export default { } ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -74,7 +74,7 @@ export default { | switchable | Whether to allow switch address | `Boolean` | `true` | | add-button-text | Add button text | String | `Add new address` | -### Event +### Events | Event | Description | Arguments | |------|------|------| @@ -93,7 +93,7 @@ export default { | tel | Phone | `String | Number` | | address | Address | `String` | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/address-list/zh-CN.md b/packages/address-list/zh-CN.md index d680e7690..c42fe86c9 100644 --- a/packages/address-list/zh-CN.md +++ b/packages/address-list/zh-CN.md @@ -65,7 +65,7 @@ export default { ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -76,7 +76,7 @@ export default { | disabled-text | 不可配送提示文案 | `String` | - | 1.3.0 | | switchable | 是否允许切换地址 | `Boolean` | `true` | 1.3.8 | -### Event +### Events | 事件名 | 说明 | 回调参数 | 版本 | |------|------|------|------| @@ -97,7 +97,7 @@ export default { | tel | 收货人手机号 | `String | Number` | | address | 收货地址 | `String` | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/area/en-US.md b/packages/area/en-US.md index 4eca74b4c..abc6d2d11 100644 --- a/packages/area/en-US.md +++ b/packages/area/en-US.md @@ -37,7 +37,7 @@ Set `columns-num` with 2, you'll have a 2 level picker. ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -51,7 +51,7 @@ Set `columns-num` with 2, you'll have a 2 level picker. | confirm-button-text | Text of confirm button | `String` | `Confirm` | | cancel-button-text | Text of cancel button | `String` | `Cancel` | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/area/zh-CN.md b/packages/area/zh-CN.md index aafda4c90..0a3b55333 100644 --- a/packages/area/zh-CN.md +++ b/packages/area/zh-CN.md @@ -35,7 +35,7 @@ Vue.use(Area); ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -49,7 +49,7 @@ Vue.use(Area); | confirm-button-text | 确认按钮文字 | `String` | `确认` | 1.5.3 | | cancel-button-text | 取消按钮文字 | `String` | `取消` | 1.5.3 | -### Event +### Events | 事件 | 说明 | 回调参数 | | --- | --- | --- | diff --git a/packages/button/en-US.md b/packages/button/en-US.md index 739e19f54..85e4ab638 100644 --- a/packages/button/en-US.md +++ b/packages/button/en-US.md @@ -68,7 +68,7 @@ Vue.use(Button); Mini ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -90,7 +90,7 @@ Vue.use(Button); | 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` | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/button/zh-CN.md b/packages/button/zh-CN.md index 7a8327f21..94c7dd362 100644 --- a/packages/button/zh-CN.md +++ b/packages/button/zh-CN.md @@ -78,7 +78,7 @@ Vue.use(Button); 迷你按钮 ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -101,7 +101,7 @@ Vue.use(Button); | to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | 1.6.5 | | replace | 跳转时是否替换当前页面历史 | `Boolean` | `false` | 1.6.5 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/card/en-US.md b/packages/card/en-US.md index 7c3dbbae9..837704f78 100644 --- a/packages/card/en-US.md +++ b/packages/card/en-US.md @@ -42,7 +42,7 @@ Use slot to custom content. ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -58,13 +58,13 @@ Use slot to custom content. | thumb-link | Thumb link URL | `String` | - | | lazy-load | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | `Boolean` | `false` | -### Event +### Events | Event | Description | Arguments | |------|------|------| | click | Triggered when clicked | - | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/card/zh-CN.md b/packages/card/zh-CN.md index c6b1e2560..a124f871d 100644 --- a/packages/card/zh-CN.md +++ b/packages/card/zh-CN.md @@ -42,7 +42,7 @@ Vue.use(Card); ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -58,13 +58,13 @@ Vue.use(Card); | thumb-link | 点击左侧图片后的跳转链接 | `String` | - | 1.3.4 | | lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `Boolean` | `false` | 1.5.0 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| | click | 点击时触发 | - | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/cell/en-US.md b/packages/cell/en-US.md index 550aa592f..70e148cd7 100644 --- a/packages/cell/en-US.md +++ b/packages/cell/en-US.md @@ -90,14 +90,14 @@ Vue.use(Cell).use(CellGroup); ``` -### CellGroup API +### CellGroup Props | Attribute | Description | Type | Default | |------|------|------|------| | title | Group title | `String` | - | | border | Whether to show outer border | `Boolean` | `true` | -### Cell API +### Cell Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -120,13 +120,13 @@ Vue.use(Cell).use(CellGroup); | value-class | Value className | `any` | - | | label-class | Label className | `any` | - | -### Cell Event +### Cell Events | Event | Description | Arguments | |------|------|------| | click | Triggered when click cell | - | -### Cell Slot +### Cell Slots | Name | Description | |------|------| diff --git a/packages/cell/zh-CN.md b/packages/cell/zh-CN.md index 1a66d43f4..f545be4da 100644 --- a/packages/cell/zh-CN.md +++ b/packages/cell/zh-CN.md @@ -94,14 +94,14 @@ Vue.use(Cell).use(CellGroup); ``` -### CellGroup API +### CellGroup Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| | title | 分组标题 | `String` | `-` | 1.6.9 | | border | 是否显示外边框 | `Boolean` | `true` | - | -### Cell API +### Cell Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -124,13 +124,13 @@ Vue.use(Cell).use(CellGroup); | value-class | 右侧内容额外类名 | `any` | - | 1.4.8 | | label-class | 描述信息额外类名 | `any` | - | 1.4.8 | -### Cell Event +### Cell Events | 事件名 | 说明 | 回调参数 | |------|------|------| | click | 点击单元格时触发 | - | -### Cell Slot +### Cell Slots | 名称 | 说明 | |------|------| diff --git a/packages/checkbox/en-US.md b/packages/checkbox/en-US.md index 617163f95..f292a948b 100644 --- a/packages/checkbox/en-US.md +++ b/packages/checkbox/en-US.md @@ -134,7 +134,7 @@ export default { ``` -### Checkbox API +### Checkbox Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -146,7 +146,7 @@ export default { | label-position | Can be set to `left` | `String` | `right` | | checked-color | Checked color | `String` | `#1989fa` | - | -### CheckboxGroup API +### CheckboxGroup Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -154,20 +154,20 @@ export default { | disabled | Disable all checkboxes | `Boolean` | `false` | | max | Maximum amount of checked options | `Number` | `0`(Unlimited) | -### Checkbox Event +### Checkbox Events | Event | Description | Parameters | |------|------|------| | change | Triggered when value changed | current value | | click | Triggered when click checkbox | event: Event | -### CheckboxGroup Event +### CheckboxGroup Events | Event | Description | Parameters | |------|------|------| | change | Triggered when value changed | current value | -### Checkbox Slot +### Checkbox Slots | Name | Description | slot-scope | |------|------|------| diff --git a/packages/checkbox/zh-CN.md b/packages/checkbox/zh-CN.md index 6724af47b..43d0a3f0c 100644 --- a/packages/checkbox/zh-CN.md +++ b/packages/checkbox/zh-CN.md @@ -137,7 +137,7 @@ export default { } ``` -### Checkbox API +### Checkbox Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -149,7 +149,7 @@ export default { | label-position | 文本位置，可选值为 `left` | `String` | `right` | 1.1.11 | | checked-color | 选中状态颜色 | `String` | `#1989fa` | 1.4.3 | -### CheckboxGroup API +### CheckboxGroup Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -157,20 +157,20 @@ export default { | disabled | 是否禁用所有复选框 | `Boolean` | `false` | - | | max | 设置最大可选数，0 为无限制 | `Number` | `0` | - | -### Checkbox Event +### Checkbox Events | 事件名 | 说明 | 回调参数 | |------|------|------| | change | 当绑定值变化时触发的事件 | 当前组件的值 | | click | 点击复选框时触发 | event: Event | -### CheckboxGroup Event +### CheckboxGroup Events | 事件名 | 说明 | 回调参数 | |------|------|------| | change | 当绑定值变化时触发的事件 | 当前组件的值 | -### Checkbox Slot +### Checkbox Slots | 名称 | 说明 | slot-scope | |------|------|------| diff --git a/packages/circle/en-US.md b/packages/circle/en-US.md index cc11a94ae..408f816f6 100644 --- a/packages/circle/en-US.md +++ b/packages/circle/en-US.md @@ -53,7 +53,7 @@ export default { ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -68,7 +68,7 @@ export default { | stroke-width | Stroke width | `Number` | `40` | | clockwise | Is clockwise | `Boolean` | `true` | -### Cell Slot +### Slots | Name | Description | |------|------| diff --git a/packages/circle/zh-CN.md b/packages/circle/zh-CN.md index 8d31fdee4..f4541c54d 100644 --- a/packages/circle/zh-CN.md +++ b/packages/circle/zh-CN.md @@ -54,7 +54,7 @@ export default { ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -69,7 +69,7 @@ export default { | stroke-width | 进度条宽度 | `Number` | `40` | - | | clockwise | 是否顺时针增加 | `Boolean` | `true` | - | -### Circle Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/col/en-US.md b/packages/col/en-US.md index dfd57091c..0ac53e4f7 100644 --- a/packages/col/en-US.md +++ b/packages/col/en-US.md @@ -85,9 +85,7 @@ Setting `type` to `flex` to enable flex layout ``` -### API - -#### Row +### Row Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -97,7 +95,7 @@ Setting `type` to `flex` to enable flex layout | 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` | -#### Col +### Col Props | Attribute | Description | Type | Default | |------|------|------|------| diff --git a/packages/col/zh-CN.md b/packages/col/zh-CN.md index 3e46cfb7e..a495922e0 100644 --- a/packages/col/zh-CN.md +++ b/packages/col/zh-CN.md @@ -86,9 +86,7 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置 ``` -### API - -#### Row +### Row Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -98,7 +96,7 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置 | justify | Flex 主轴对齐方式，可选值为 `end` `center`
`space-around` `space-between` | `String` | `start` | 1.1.9 | | align | Flex 交叉轴对齐方式，可选值为 `center` `bottom` | `String` | `top` | 1.1.9 | -#### Col +### Col Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| diff --git a/packages/collapse/en-US.md b/packages/collapse/en-US.md index 5249b471c..74a587250 100644 --- a/packages/collapse/en-US.md +++ b/packages/collapse/en-US.md @@ -71,7 +71,7 @@ export default { -### Collapse API +### Collapse Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -79,13 +79,13 @@ export default { | accordion | Whether to be accordion mode | `Boolean` | `false` | | border | Whether to show outer border | `Boolean` | `true` | -### Collapse Event +### Collapse Events | Event | Description | Arguments | |------|------|------| | change | Triggered when switch panel | activeNames: `string | array` | -### CollapseItem API +### CollapseItem Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -102,7 +102,7 @@ export default { | value-class | Value className | `String` | - | | label-class | Label className | `String` | - | -### CollapseItem Slot +### CollapseItem Slots | Name | Description | |------|------| diff --git a/packages/collapse/zh-CN.md b/packages/collapse/zh-CN.md index 99762e151..cb007c63f 100644 --- a/packages/collapse/zh-CN.md +++ b/packages/collapse/zh-CN.md @@ -83,7 +83,7 @@ export default { -### Collapse API +### Collapse Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -91,13 +91,13 @@ export default { | accordion | 是否开启手风琴模式 | `Boolean` | `false` | - | | border | 是否显示外边框 | `Boolean` | `true` | 1.6.9 | -### Collapse Event +### Collapse Events | 事件名 | 说明 | 回调参数 | |------|------|------| | change | 切换面板时触发 | activeNames: `string | array` | -### CollapseItem API +### CollapseItem Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------|------| @@ -114,7 +114,7 @@ export default { | value-class | 右侧内容额外类名 | `String` | - | 1.4.8 | | label-class | 描述信息额外类名 | `String` | - | 1.4.8 | -### CollapseItem Slot +### CollapseItem Slots | 名称 | 说明 | |------|------| diff --git a/packages/contact-card/en-US.md b/packages/contact-card/en-US.md index 7c21866f5..a60aa324f 100644 --- a/packages/contact-card/en-US.md +++ b/packages/contact-card/en-US.md @@ -131,7 +131,7 @@ export default { ``` -### ContactCard API +### ContactCard Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -140,13 +140,13 @@ export default { | tel | Phone | `String` | - | | add-text | Add card text | `String` | `Add contact info` | -### ContactCard Event +### ContactCard Events | Event | Description | Arguments | |------|------|------| | click | Triggered when clicked | - | -### ContactList API +### ContactList Props | Attribute | Description | Type | Default | |------|------|------|------|------| @@ -154,7 +154,7 @@ export default { | list | Contact list | `Array` | `[]` | | add-text | Add button text | `String` | `Add new contact` | -### ContactList Event +### ContactList Events | Event | Description | Arguments | |------|------|------| @@ -162,7 +162,7 @@ export default { | edit | Triggered when click edit button | item: contact object，index | | select | Triggered when select contact | item: contact object | -### ContactEdit API +### ContactEdit Props | Attribute | Description | Type | Default | |------|------|------|------|------| | contact-info | Contact Info | `Object` | `[]` | @@ -171,7 +171,7 @@ export default { | is-deleting | Whether to show delete button loading status | `Boolean` | `false` | | tel-validator | The method to validate tel | `(tel: string) => boolean` | - | -### ContactEdit Event +### ContactEdit Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/contact-card/zh-CN.md b/packages/contact-card/zh-CN.md index ba36bc122..c9bccd607 100644 --- a/packages/contact-card/zh-CN.md +++ b/packages/contact-card/zh-CN.md @@ -130,7 +130,7 @@ export default { /> ``` -### ContactCard API +### ContactCard Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -139,13 +139,13 @@ export default { | tel | 联系人手机号 | `String` | - | - | | add-text | 添加时的文案提示 | `String` | `添加订单联系人信息` | - | -### ContactCard Event +### ContactCard Events | 事件名 | 说明 | 回调参数 | |------|------|------| | click | 点击时触发 | - | -### ContactList API +### ContactList Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -153,7 +153,7 @@ export default { | list | 联系人列表 | `Array` | `[]` | - | | add-text | 新建按钮文案 | `String` | `新建联系人` | - | -### ContactList Event +### ContactList Events | 事件名 | 说明 | 回调参数 | |------|------|------| @@ -161,7 +161,7 @@ export default { | edit | 点击编辑按钮时触发 | item: 当前联系人对象，index: 索引 | | select | 切换选中的联系人时触发 | item: 当前联系人对象，index: 索引 | -### ContactEdit API +### ContactEdit Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -171,7 +171,7 @@ export default { | is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | - | | tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - | - | -### ContactEdit Event +### ContactEdit Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/coupon-list/en-US.md b/packages/coupon-list/en-US.md index 4644d6b67..5f16498cb 100644 --- a/packages/coupon-list/en-US.md +++ b/packages/coupon-list/en-US.md @@ -65,7 +65,7 @@ export default { } ``` -### CouponCell API +### CouponCell Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -76,7 +76,7 @@ export default { | border | Whether to show innner border | `Boolean` | `true` | | currency | Currency symbol | `String` | `¥` | -### CouponList API +### CouponList Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -93,7 +93,7 @@ export default { | input-placeholder | Input placeholder | `String` | `Coupon code` | | currency | Currency symbol | `String` | `¥` | -### CouponList Event +### CouponList Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/coupon-list/zh-CN.md b/packages/coupon-list/zh-CN.md index 58eeee1ba..897cb9ccf 100644 --- a/packages/coupon-list/zh-CN.md +++ b/packages/coupon-list/zh-CN.md @@ -66,7 +66,7 @@ export default { ``` -### CouponCell API +### CouponCell Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -77,7 +77,7 @@ export default { | border | 是否显示内边框 | `Boolean` | `true` | 1.3.10 | | currency | 货币符号 | `String` | `¥` | - | 1.5.0 | -### CouponList API +### CouponList Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -96,7 +96,7 @@ export default { | show-exchange-bar | 是否展示兑换栏 | `Boolean` | `true` | - | | currency | 货币符号 | `String` | `¥` | - | 1.5.0 | -### CouponList Event +### CouponList Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/datetime-picker/en-US.md b/packages/datetime-picker/en-US.md index eb82bfffe..b45a5c387 100644 --- a/packages/datetime-picker/en-US.md +++ b/packages/datetime-picker/en-US.md @@ -108,7 +108,7 @@ export default { } ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------|------| @@ -127,7 +127,7 @@ export default { | cancel-button-text | Text of cancel button | `String` | `Cancel` | | visible-item-count | Count of visible columns | `Number` | `5` | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/datetime-picker/zh-CN.md b/packages/datetime-picker/zh-CN.md index fc554607d..bcfb23f08 100644 --- a/packages/datetime-picker/zh-CN.md +++ b/packages/datetime-picker/zh-CN.md @@ -109,7 +109,7 @@ export default { } ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -129,7 +129,7 @@ export default { | cancel-button-text | 取消按钮文字 | `String` | `取消` | 1.0.4 | | visible-item-count | 可见的选项个数 | `Number` | `5` | 1.0.4 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/dialog/en-US.md b/packages/dialog/en-US.md index 5292ea2d0..6494d3b5c 100644 --- a/packages/dialog/en-US.md +++ b/packages/dialog/en-US.md @@ -131,7 +131,7 @@ export default { | beforeClose | Callback before close,
call done() to close dialog,
call done(false) to cancel loading | (action: string, done: function) => void | - | | getContainer | Return the mount node for Dialog | `String | () => HTMLElement` | `body` | -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -151,7 +151,7 @@ export default { | before-close | Callback before close,
call done() to close dialog,
call done(false) to cancel loading | (action: string, done: function) => void | - | | get-container | Return the mount node for Dialog | `String | () => HTMLElement` | `body` | -### Event +### Events | Event | Description | Parameters | |------|------|------| diff --git a/packages/dialog/zh-CN.md b/packages/dialog/zh-CN.md index 523b91fa8..5a5b468cc 100644 --- a/packages/dialog/zh-CN.md +++ b/packages/dialog/zh-CN.md @@ -134,9 +134,9 @@ export default { | beforeClose | 关闭前的回调函数，
调用 done() 后关闭弹窗，
调用 done(false) 阻止弹窗关闭 | `(action, done) => void` | - | 1.1.6 | | getContainer | 指定挂载的节点，可以传入选择器，
或一个返回节点的函数 | `String | () => HTMLElement` | `body` | 1.6.11 | -### API +### Props -通过组件调用 `Dialog` 时，支持以下 API： +通过组件调用 `Dialog` 时，支持以下 Props： | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -156,7 +156,7 @@ export default { | before-close | 关闭前的回调函数，
调用 done() 后关闭弹窗，
调用 done(false) 阻止弹窗关闭 | `(action, done) => void` | - | 1.1.6 | | get-container | 指定挂载的节点，可以传入选择器，
或一个返回节点的函数 | `String | () => HTMLElement` | `body` | 1.1.6 | -### Event +### Events 通过组件调用 `Dialog` 时，支持以下事件： diff --git a/packages/field/en-US.md b/packages/field/en-US.md index 69eb0f50f..a8fee3f7a 100644 --- a/packages/field/en-US.md +++ b/packages/field/en-US.md @@ -109,7 +109,7 @@ Use button slot to insert button ``` -### API +### Props Field support all native properties of input tag，such as `maxlength`、`placeholder`、`autofocus` @@ -136,7 +136,7 @@ Field support all native properties of input tag，such as `maxlength`、`placeh | left-icon | Left side icon name | `String` | - | | right-icon | Right side icon name | `String` | - | -### Event +### Events Field support all native events of input tag，such as `focus`、`blur`、`keypress` @@ -156,7 +156,7 @@ Use ref to get field instance and call instance methods | focus | - | - | Trigger input focus | | blur | - | - | Trigger input blur | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/field/zh-CN.md b/packages/field/zh-CN.md index def6ede4e..0a7907594 100644 --- a/packages/field/zh-CN.md +++ b/packages/field/zh-CN.md @@ -116,7 +116,7 @@ Vue.use(Field); ``` -### API +### Props Field 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`placeholder`、`autofocus` 等 @@ -143,7 +143,7 @@ Field 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`pla | left-icon | 输入框左侧图标名称或图片链接，可选值见 Icon 组件 | `String` | - | 1.5.7 | | right-icon | 输入框尾部图标名称或图片链接，可选值见 Icon 组件 | `String` | - | 1.5.7 | -### Event +### Events Field 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、`keypress` 等 @@ -163,7 +163,7 @@ Field 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、`k | focus | - | - | 获取输入框焦点 | | blur | - | - | 取消输入框焦点 | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/goods-action/en-US.md b/packages/goods-action/en-US.md index fa4766b9c..994e84cb0 100644 --- a/packages/goods-action/en-US.md +++ b/packages/goods-action/en-US.md @@ -85,7 +85,7 @@ Use `info` prop to show messages in upper right corner of icon ``` -### API +### Props #### GoodsAction diff --git a/packages/goods-action/zh-CN.md b/packages/goods-action/zh-CN.md index 014b888e0..23da4cbee 100644 --- a/packages/goods-action/zh-CN.md +++ b/packages/goods-action/zh-CN.md @@ -84,7 +84,7 @@ export default { ``` -### API +### Props #### GoodsAction diff --git a/packages/icon/en-US.md b/packages/icon/en-US.md index ccba887e1..8a04af738 100644 --- a/packages/icon/en-US.md +++ b/packages/icon/en-US.md @@ -53,7 +53,7 @@ import 'vant/lib/icon/local.css'; ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -64,7 +64,7 @@ import 'vant/lib/icon/local.css'; | class-prefix | ClassName prefix | `String` | `van-icon` | | tag | HTML Tag | `String` | `i` | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/icon/zh-CN.md b/packages/icon/zh-CN.md index 0ba280166..b6cb0845b 100644 --- a/packages/icon/zh-CN.md +++ b/packages/icon/zh-CN.md @@ -56,7 +56,7 @@ import 'vant/lib/icon/local.css'; ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -67,7 +67,7 @@ import 'vant/lib/icon/local.css'; | class-prefix | 类名前缀 | `String` | `van-icon` | 1.2.1 | | tag | HTML 标签 | `String` | `i` | 1.6.10 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/image-preview/en-US.md b/packages/image-preview/en-US.md index 4e50c0467..e10e0b7d6 100644 --- a/packages/image-preview/en-US.md +++ b/packages/image-preview/en-US.md @@ -114,14 +114,14 @@ export default { | max-zoom | Max zoom | `Number` | `3` | | min-zoom | Min zoom | `Number` | `1/3` | -### Event +### Events | Event | Description | Parameters | |------|------|------| | close | Triggered when close | { index, url } | | change | Triggered when current image change | index: index of current image | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/image-preview/zh-CN.md b/packages/image-preview/zh-CN.md index 366bafa17..ebe33cbb7 100644 --- a/packages/image-preview/zh-CN.md +++ b/packages/image-preview/zh-CN.md @@ -111,9 +111,9 @@ export default { | maxZoom | 手势缩放时，最大缩放比例 | `Number` | `3` | 1.6.14 | | minZoom | 手势缩放时，最小缩放比例 | `Number` | `1/3` | 1.6.14 | -### API +### Props -通过组件调用 `ImagePreview` 时，支持以下 API： +通过组件调用 `ImagePreview` 时，支持以下 Props： | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -128,7 +128,7 @@ export default { | max-zoom | 手势缩放时，最大缩放比例 | `Number` | `3` | 1.6.14 | | min-zoom | 手势缩放时，最小缩放比例 | `Number` | `1/3` | 1.6.14 | -### Event +### Events 通过组件调用 `ImagePreview` 时，支持以下事件： @@ -137,7 +137,7 @@ export default { | close | 关闭时触发 | { index: 索引, url: 图片链接 } | | change | 切换当前图片时触发 | index, 当前图片的索引 | -### Slot +### Slots 通过组件调用 `ImagePreview` 时，支持以下插槽： diff --git a/packages/list/en-US.md b/packages/list/en-US.md index 03eba18ca..b89f41226 100644 --- a/packages/list/en-US.md +++ b/packages/list/en-US.md @@ -91,7 +91,7 @@ export default { } ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -105,7 +105,7 @@ export default { | immediate-check | Whether to check loading position immediately after mounted | `Boolean` | `true` | | direction | Scroll direction，can be set to `up` | `String` | `down` | -### Event +### Events | Event | Description | Arguments | |------|------|------| @@ -119,7 +119,7 @@ Use ref to get list instance and call instance methods |------|------|------|------| | check | - | - | Check scroll position | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/list/zh-CN.md b/packages/list/zh-CN.md index 146a969a0..1bd2414bf 100644 --- a/packages/list/zh-CN.md +++ b/packages/list/zh-CN.md @@ -98,7 +98,7 @@ export default { } ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -112,7 +112,7 @@ export default { | immediate-check | 是否在初始化时立即执行滚动位置检查 | `Boolean` | `true` | - | | direction | 滚动触发加载的方向，可选值为`up` | `String` | `down` | 1.6.16 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| @@ -126,7 +126,7 @@ export default { |------|------|------|------| | check | - | - | 检查当前的滚动位置，若已滚动至底部，则会触发 load 事件 | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/loading/en-US.md b/packages/loading/en-US.md index 9d8a037be..ce31148ce 100644 --- a/packages/loading/en-US.md +++ b/packages/loading/en-US.md @@ -29,7 +29,7 @@ Vue.use(Loading); Loading... ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -38,7 +38,7 @@ Vue.use(Loading); | size | Icon size | `String | Number` | `30px` | | text-size | Text font size | `String | Number` | `14px` | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/loading/zh-CN.md b/packages/loading/zh-CN.md index 9ea169ad6..8a1709728 100644 --- a/packages/loading/zh-CN.md +++ b/packages/loading/zh-CN.md @@ -29,7 +29,7 @@ Vue.use(Loading); 加载中... ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -38,7 +38,7 @@ Vue.use(Loading); | size | 加载图标大小 | `String | Number` | `30px` | - | | text-size | 文字大小 | `String | Number` | `14px` | 2.0.0 | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/nav-bar/en-US.md b/packages/nav-bar/en-US.md index 8f863f4b3..f31c2767e 100644 --- a/packages/nav-bar/en-US.md +++ b/packages/nav-bar/en-US.md @@ -44,7 +44,7 @@ export default { ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -56,7 +56,7 @@ export default { | border | Whether to show bottom border | `Boolean` | `true` | | z-index | Z-index | `Number` | `1` | -### Slot +### Slots | Name | Description | |------|------| @@ -64,7 +64,7 @@ export default { | left | Custom left side content | | right | Custom right side content | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/nav-bar/zh-CN.md b/packages/nav-bar/zh-CN.md index 63bda8216..aa312f778 100644 --- a/packages/nav-bar/zh-CN.md +++ b/packages/nav-bar/zh-CN.md @@ -45,7 +45,7 @@ export default { ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -57,7 +57,7 @@ export default { | border | 是否显示下边框 | `Boolean` | `true` | 1.4.7 | | z-index | 元素 z-index | `Number` | `1` | - | -### Slot +### Slots | 名称 | 说明 | |------|------| @@ -65,7 +65,7 @@ export default { | left | 自定义左侧区域内容 | | right | 自定义右侧区域内容 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/notice-bar/en-US.md b/packages/notice-bar/en-US.md index 6445452f6..568e17007 100644 --- a/packages/notice-bar/en-US.md +++ b/packages/notice-bar/en-US.md @@ -46,7 +46,7 @@ Vue.use(NoticeBar); ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -60,14 +60,14 @@ Vue.use(NoticeBar); | color | Text color | `String` | `#f60` | | background | Background color | `String` | `#fff7cc` | -### Event +### Events | Event | Description | Arguments | |------|------|------| | click | Triggered when click NoticeBar | - | | close | Triggered when closed | - | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/notice-bar/zh-CN.md b/packages/notice-bar/zh-CN.md index 94e63e90c..449b5266e 100644 --- a/packages/notice-bar/zh-CN.md +++ b/packages/notice-bar/zh-CN.md @@ -54,7 +54,7 @@ Vue.use(NoticeBar); ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -68,14 +68,14 @@ Vue.use(NoticeBar); | color | 文本颜色 | `String` | `#f60` | - | | background | 滚动条背景 | `String` | `#fff7cc` | - | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| | click | 点击时触发 | - | | close | 关闭时触发 | - | -### Slot +### Slots | 名称 | 内容 | |------|------| diff --git a/packages/notify/en-US.md b/packages/notify/en-US.md index 3f4a8652d..02318616e 100644 --- a/packages/notify/en-US.md +++ b/packages/notify/en-US.md @@ -47,7 +47,7 @@ export default { | Notify.setDefaultOptions | `options` | `void` | Set default options of all notifies | | Notify.resetDefaultOptions | - | `void` | Reset default options of all notifies | -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| diff --git a/packages/number-keyboard/en-US.md b/packages/number-keyboard/en-US.md index 335c8b39d..6a05c316f 100644 --- a/packages/number-keyboard/en-US.md +++ b/packages/number-keyboard/en-US.md @@ -59,7 +59,7 @@ export default { /> ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -75,7 +75,7 @@ export default { | hide-on-click-outside | Whether to hide keyboard when click outside | `Boolean` | `true` | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | `Boolean` | `false` | -### Event +### Events | Event | Description | Arguments | |------|------|------| @@ -86,7 +86,7 @@ export default { | show | Triggered when keyboard is fully displayed. | - | | hide | Triggered when keyboard is fully hidden. | - | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/number-keyboard/zh-CN.md b/packages/number-keyboard/zh-CN.md index c51bd12c5..71fff9e55 100644 --- a/packages/number-keyboard/zh-CN.md +++ b/packages/number-keyboard/zh-CN.md @@ -59,7 +59,7 @@ export default { /> ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -75,7 +75,7 @@ export default { | hide-on-click-outside | 点击外部时是否收起键盘 | `Boolean` | `true` | - | | safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `Boolean` | `false` | 1.6.15 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| @@ -86,7 +86,7 @@ export default { | show | 键盘完全弹出时触发 | - | | hide | 键盘完全收起时触发 | - | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/pagination/en-US.md b/packages/pagination/en-US.md index 54804ad86..423e049f7 100644 --- a/packages/pagination/en-US.md +++ b/packages/pagination/en-US.md @@ -50,7 +50,7 @@ export default { /> ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -64,7 +64,7 @@ export default { | show-page-size | Count of page size to show | `Number` | `5` | | force-ellipses | Whether to show ellipses | `Boolean` | `false` | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/pagination/zh-CN.md b/packages/pagination/zh-CN.md index 194d678a6..d4b7e96e6 100644 --- a/packages/pagination/zh-CN.md +++ b/packages/pagination/zh-CN.md @@ -52,7 +52,7 @@ export default { /> ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -66,7 +66,7 @@ export default { | show-page-size | 显示的页码个数 | `Number` | `5` | - | | force-ellipses | 显示省略号 | `Boolean` | `false` | - | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/panel/en-US.md b/packages/panel/en-US.md index 67dacbb4b..5d73d3f58 100644 --- a/packages/panel/en-US.md +++ b/packages/panel/en-US.md @@ -29,7 +29,7 @@ Vue.use(Panel); ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -38,7 +38,7 @@ Vue.use(Panel); | desc | Description | `String` | - | | status | Status | `String` | - | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/panel/zh-CN.md b/packages/panel/zh-CN.md index 497104279..6f7b74c8f 100644 --- a/packages/panel/zh-CN.md +++ b/packages/panel/zh-CN.md @@ -31,7 +31,7 @@ Vue.use(Panel); ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -40,7 +40,7 @@ Vue.use(Panel); | status | 状态 | `String` | - | - | | icon | 标题左侧图标名称或图片链接，可选值见 Icon 组件 | `String` | - | 1.3.8 | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/password-input/en-US.md b/packages/password-input/en-US.md index 4b3578d08..b4b91a173 100644 --- a/packages/password-input/en-US.md +++ b/packages/password-input/en-US.md @@ -59,7 +59,7 @@ export default { /> ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -69,7 +69,7 @@ export default { | info | Bottom info | `String` | - | | error-info | Bottom error info | `String` | - | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/password-input/zh-CN.md b/packages/password-input/zh-CN.md index 777757fb2..8baa27837 100644 --- a/packages/password-input/zh-CN.md +++ b/packages/password-input/zh-CN.md @@ -60,7 +60,7 @@ export default { /> ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -70,7 +70,7 @@ export default { | info | 输入框下方文字提示 | `String` | - | - | | error-info | 输入框下方错误提示 | `String` | - | - | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/picker/en-US.md b/packages/picker/en-US.md index 98538b035..053eaa710 100644 --- a/packages/picker/en-US.md +++ b/packages/picker/en-US.md @@ -134,7 +134,7 @@ When Picker columns data is acquired asynchronously, use `loading` prop to show ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -149,7 +149,7 @@ When Picker columns data is acquired asynchronously, use `loading` prop to show | visible-item-count | Count of visible columns | `Number` | `5` | | default-index | Default value index of single column picker | `Number` | `0` | -### Event +### Events Picker events will pass different parameters according to the columns are single or multiple | Event | Description | Arguments | @@ -158,7 +158,7 @@ Picker events will pass different parameters according to the columns are single | cancel | Triggered when click cancel button | Single column：current value，current index
Multiple columns：current values，current indexes | | change | Triggered when current option changed | Single column：Picker instance, current value，current index
Multiple columns：Picker instance, current values，column index | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/picker/zh-CN.md b/packages/picker/zh-CN.md index dbc771364..cd36661e2 100644 --- a/packages/picker/zh-CN.md +++ b/packages/picker/zh-CN.md @@ -143,7 +143,7 @@ export default { ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -158,7 +158,7 @@ export default { | visible-item-count | 可见的选项个数 | `Number` | `5` | - | | default-index | 单列选择器的默认选中项索引，
多列选择器请参考下方的 Columns 配置 | `Number` | `0` | 1.6.9 | -### Event +### Events Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 @@ -168,7 +168,7 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 | cancel | 点击取消按钮时触发 | 单列：选中值，选中值对应的索引
多列：所有列选中值，所有列选中值对应的索引 | | change | 选项改变时触发 | 单列：Picker 实例，选中值，选中值对应的索引
多列：Picker 实例，所有列选中值，当前列对应的索引 | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/popup/en-US.md b/packages/popup/en-US.md index 721229d76..ceda3380a 100644 --- a/packages/popup/en-US.md +++ b/packages/popup/en-US.md @@ -35,7 +35,7 @@ Use `position` prop to set popup display position ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -50,7 +50,7 @@ Use `position` prop to set popup display position | lazy-render | Whether to lazy render util appeared | `Boolean` | `true` | | get-container | Return the mount node for Popup | `String | () => HTMLElement` | - | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/popup/zh-CN.md b/packages/popup/zh-CN.md index acf0dd09e..6cc9b8cdb 100644 --- a/packages/popup/zh-CN.md +++ b/packages/popup/zh-CN.md @@ -35,7 +35,7 @@ export default { ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -50,7 +50,7 @@ export default { | lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | 1.0.0 | | lazy-render | 是否在显示弹层时才渲染节点 | `Boolean` | `true` | 1.1.5 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/progress/en-US.md b/packages/progress/en-US.md index 3bfa4f4d3..538618c77 100644 --- a/packages/progress/en-US.md +++ b/packages/progress/en-US.md @@ -48,7 +48,7 @@ Use `pivot-text` to custom text，use `color` to custom bar color /> ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| diff --git a/packages/progress/zh-CN.md b/packages/progress/zh-CN.md index 7c9103b74..f13023fb9 100644 --- a/packages/progress/zh-CN.md +++ b/packages/progress/zh-CN.md @@ -50,7 +50,7 @@ Vue.use(Progress); /> ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| diff --git a/packages/pull-refresh/en-US.md b/packages/pull-refresh/en-US.md index ede844c12..016ca7431 100644 --- a/packages/pull-refresh/en-US.md +++ b/packages/pull-refresh/en-US.md @@ -39,7 +39,7 @@ export default { } ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -54,14 +54,14 @@ export default { | disabled | Whether to disable | `Boolean` | `false` | -### Event +### Events | Event | Description | Parameters | |------|------|------| | refresh | Triggered when pull refresh | - | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/pull-refresh/zh-CN.md b/packages/pull-refresh/zh-CN.md index 397d9939f..5c1f975a1 100644 --- a/packages/pull-refresh/zh-CN.md +++ b/packages/pull-refresh/zh-CN.md @@ -40,7 +40,7 @@ export default { } ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -54,13 +54,13 @@ export default { | head-height | 顶部内容高度 | `Number` | `50` | - | | disabled | 是否禁用 | `Boolean` | `false` | 1.1.10 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| | refresh | 下拉刷新时触发 | - | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/radio/en-US.md b/packages/radio/en-US.md index 3fb03578b..106331f36 100644 --- a/packages/radio/en-US.md +++ b/packages/radio/en-US.md @@ -88,7 +88,7 @@ export default { ``` -### Radio API +### Radio Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -99,26 +99,26 @@ export default { | label-position | Can be set to `left` | `String` | `right` | | checked-color | Checked color | `String` | `#1989fa` | - | -### RadioGroup API +### RadioGroup Props | Attribute | Description | Type | Default | |------|------|------|------| | v-model | Name of checked radio | `any` | - | | disabled | Diable all radios | `Boolean` | `false` | -### Radio Event +### Radio Events | Event | Description | Parameters | |------|------|------| | click | Triggered when click radio | event: Event | -### RadioGroup Event +### RadioGroup Events | Event | Description | Parameters | |------|------|------| | change | Triggered when value changed | current value | -### Radio Slot +### Radio Slots | Name | Description | slot-scope | |------|------|------| diff --git a/packages/radio/zh-CN.md b/packages/radio/zh-CN.md index b5e63c585..8857b730e 100644 --- a/packages/radio/zh-CN.md +++ b/packages/radio/zh-CN.md @@ -92,7 +92,7 @@ export default { ``` -### Radio API +### Radio Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -103,26 +103,26 @@ export default { | label-position | 文本位置，可选值为 `left` | `String` | `right` | 1.1.13 | | checked-color | 选中状态颜色 | `String` | `#1989fa` | 1.4.5 | -### RadioGroup API +### RadioGroup Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| | v-model | 当前选中项的标识符 | 任意类型 | - | - | | disabled | 是否禁用所有单选框 | `Boolean` | `false` | - | -### Radio Event +### Radio Events | 事件名 | 说明 | 回调参数 | |------|------|------| | click | 点击单选框时触发 | event: Event | -### RadioGroup Event +### RadioGroup Events | 事件名 | 说明 | 回调参数 | |------|------|------| | change | 当绑定值变化时触发的事件 | 当前选中项的 name | -### Radio Slot +### Radio Slots | 名称 | 说明 | slot-scope | |------|------|------| diff --git a/packages/rate/en-US.md b/packages/rate/en-US.md index e6bf638c4..ce09365ca 100644 --- a/packages/rate/en-US.md +++ b/packages/rate/en-US.md @@ -86,7 +86,7 @@ export default { ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -102,7 +102,7 @@ export default { | disabled | Whether to disable rate | `Boolean` | `false` | | disabled-color | Disabled color | `String` | `#bdbdbd` | -### Event +### Events | Event | Description | Parameters | |------|------|------| diff --git a/packages/rate/zh-CN.md b/packages/rate/zh-CN.md index 6a9be07df..1076813ad 100644 --- a/packages/rate/zh-CN.md +++ b/packages/rate/zh-CN.md @@ -86,7 +86,7 @@ export default { ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -102,7 +102,7 @@ export default { | disabled | 是否禁用评分 | `Boolean` | `false` | - | | disabled-color | 禁用时的颜色 | `String` | `#bdbdbd` | - | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/search/en-US.md b/packages/search/en-US.md index 4ce064f78..c589b3d0e 100644 --- a/packages/search/en-US.md +++ b/packages/search/en-US.md @@ -56,7 +56,7 @@ Use `action` slot to custom right button, `cancel` event will no longer be trigg ``` -### API +### Props Search support all native properties of input tag，such as `maxlength`、`placeholder`、`autofocus` @@ -71,7 +71,7 @@ Search support all native properties of input tag，such as `maxlength`、`place | error | Whether to show error info | `Boolean` | `false` | | input-align | Input text align, can be set to `center` `right` | `String` | `left` | -### Event +### Events Search support all native events of input tag，such as `focus`、`blur`、`keypress` @@ -81,7 +81,7 @@ Search support all native events of input tag，such as `focus`、`blur`、`keyp | search | Triggered when confirm search | - | | clear | Triggered when click clear icon | - | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/search/zh-CN.md b/packages/search/zh-CN.md index 709dae427..8fca24054 100644 --- a/packages/search/zh-CN.md +++ b/packages/search/zh-CN.md @@ -48,7 +48,7 @@ Tips: 在 `van-search` 外层增加 form 标签，并且 action 不为空，即 ``` -### API +### Props Search 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`placeholder`、`autofocus` 等 @@ -63,7 +63,7 @@ Search 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`pl | error | 是否将输入内容标红 | `Boolean` | `false` | - | | input-align | 输入框内容对齐方式，可选值为 `center` `right` | `String` | `left` | - | -### Event +### Events Search 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、`keypress` 等 @@ -73,7 +73,7 @@ Search 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、` | search | 确定搜索 | - | | clear | 点击清除按钮后触发 | - | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/sidebar/en-US.md b/packages/sidebar/en-US.md index d3412bc34..5e591cdc0 100644 --- a/packages/sidebar/en-US.md +++ b/packages/sidebar/en-US.md @@ -40,19 +40,19 @@ export default { }; ``` -### Sidebar API +### Sidebar Props | Attribute | Description | Type | Default | |------|------|------|------| | active-key | Index of chosen item | `String | Number` | `0` | -### Sidebar Event +### Sidebar Events | Event | Description | Arguments | |------|------|------| | change | Triggered when item changed | key: index of current item | -### SidebarItem API +### SidebarItem Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -60,7 +60,7 @@ export default { | info | Info Message | `String | Number` | `''` | | url | Link | `String` | - | -### SidebarItem Event +### SidebarItem Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/sidebar/zh-CN.md b/packages/sidebar/zh-CN.md index 50e5c9e6d..837c8777c 100644 --- a/packages/sidebar/zh-CN.md +++ b/packages/sidebar/zh-CN.md @@ -40,19 +40,19 @@ export default { }; ``` -### Sidebar API +### Sidebar Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| | active-key | 当前导航项的索引 | `String | Number` | `0` | - | -### Sidebar Event +### Sidebar Events | 事件名 | 说明 | 回调参数 | |------|------|------| | change | 切换当前导航项时触发 | key: 当前导航项的索引 | -### SidebarItem API +### SidebarItem Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -60,7 +60,7 @@ export default { | info | 提示消息 | `String | Number` | `''` | - | | url | 跳转链接 | `String` | - | - | -### SidebarItem Event +### SidebarItem Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/skeleton/en-US.md b/packages/skeleton/en-US.md index 7e0709304..468c2f371 100644 --- a/packages/skeleton/en-US.md +++ b/packages/skeleton/en-US.md @@ -47,7 +47,7 @@ export default { } }; ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| diff --git a/packages/skeleton/zh-CN.md b/packages/skeleton/zh-CN.md index a833ee5ed..d6b3400f4 100644 --- a/packages/skeleton/zh-CN.md +++ b/packages/skeleton/zh-CN.md @@ -54,7 +54,7 @@ export default { }; ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| diff --git a/packages/sku/en-US.md b/packages/sku/en-US.md index 01026f008..076ef167a 100644 --- a/packages/sku/en-US.md +++ b/packages/sku/en-US.md @@ -96,7 +96,7 @@ Vue.use(Sku); ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -118,7 +118,7 @@ Vue.use(Sku); | message-config | Message related config | `Object` | `{}` | | get-container | Return the mount node for sku | `String | () => HTMLElement` | - | -### Event +### Events | Event | Description | Arguments | |------|------|------| @@ -137,7 +137,7 @@ Use ref to get sku instance and call instance methods |------|------|------|------| | getSkuData | - | skuData | Get current skuData | -### Slot +### Slots | Name | Description | |------|------| @@ -270,7 +270,7 @@ messageConfig: { } ``` -#### Event Params Data Structure +#### Events Params Data Structure ```javascript skuData: { diff --git a/packages/sku/zh-CN.md b/packages/sku/zh-CN.md index 35ddeae72..0a5213172 100644 --- a/packages/sku/zh-CN.md +++ b/packages/sku/zh-CN.md @@ -97,7 +97,7 @@ Vue.use(Sku); ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -121,7 +121,7 @@ Vue.use(Sku); | initial-sku | 默认选中的sku，具体参考高级用法 | `Object` | `{}` | - | | show-soldout-sku | 是否展示售罄的sku，如果展示，则为置灰不可选状态，不展示则直接隐藏 | `Boolean` | `true` | - | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| @@ -140,7 +140,7 @@ Vue.use(Sku); |------|------|------|------| | getSkuData | - | skuData | 获取当前 skuData | -### Slot +### Slots Sku 组件默认划分好了若干区块，这些区块都定义成了插槽，可以按需进行替换。区块顺序见下表： diff --git a/packages/slider/en-US.md b/packages/slider/en-US.md index bdc71cb6f..f7d1123ee 100644 --- a/packages/slider/en-US.md +++ b/packages/slider/en-US.md @@ -82,7 +82,7 @@ export default { ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------|------| @@ -96,13 +96,13 @@ export default { | inactive-color | Inactive color of bar | `String` | `#e5e5e5` | | vertical | Whether to display vertical | `Boolean` | `false` | -### Event +### Events | Event | Description | Arguments | |------|------|------| | change | Triggered after value change | value: current rate | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/slider/zh-CN.md b/packages/slider/zh-CN.md index 27e36c448..e54e3344d 100644 --- a/packages/slider/zh-CN.md +++ b/packages/slider/zh-CN.md @@ -83,7 +83,7 @@ Slider 垂直展示时，高度为 100% 父元素高度 ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -97,13 +97,13 @@ Slider 垂直展示时，高度为 100% 父元素高度 | inactive-color | 进度条默认颜色 | `String` | `#e5e5e5` | 1.5.1 | | vertical | 是否垂直展示 | `Boolean` | `false` | 1.6.13 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| | change | 进度值改变后触发 | value: 当前进度 | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/stepper/en-US.md b/packages/stepper/en-US.md index 0f3602ba5..690a2f1f8 100644 --- a/packages/stepper/en-US.md +++ b/packages/stepper/en-US.md @@ -78,7 +78,7 @@ export default { /> ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -92,7 +92,7 @@ export default { | async-change | Whether to enable async change | `Boolean` | `false` | - | | input-width | Input width | `String` | `30px` | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/stepper/zh-CN.md b/packages/stepper/zh-CN.md index c0dac11c3..f6eb8a2da 100644 --- a/packages/stepper/zh-CN.md +++ b/packages/stepper/zh-CN.md @@ -81,7 +81,7 @@ export default { /> ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -95,7 +95,7 @@ export default { | async-change | 是否开启异步变更，开启后需要手动控制输入值 | `Boolean` | `false` | - | | input-width | 输入框宽度，须指定单位 | `String` | `30px` | 1.6.13 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/steps/en-US.md b/packages/steps/en-US.md index e0d0caa6e..4b1dc3bb1 100644 --- a/packages/steps/en-US.md +++ b/packages/steps/en-US.md @@ -64,7 +64,7 @@ export default { ``` -### Steps API +### Steps Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -75,7 +75,7 @@ export default { | active-icon | Active icon name | `String` | `checked` | | inactive-icon | Active icon name | `String` | - | -### Step Slot +### Step Slots | Name | Description | |------|------| diff --git a/packages/steps/zh-CN.md b/packages/steps/zh-CN.md index 993453565..beaae043e 100644 --- a/packages/steps/zh-CN.md +++ b/packages/steps/zh-CN.md @@ -68,7 +68,7 @@ export default { ``` -### Steps API +### Steps Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -78,7 +78,7 @@ export default { | active-icon | 激活状态底部图标，可选值见 Icon 组件 | `String` | `checked` | 1.6.9 | | inactive-icon | 未激活状态底部图标，可选值见 Icon 组件 | `String` | - | 2.0.0 | -### Step Slot +### Step Slots | 名称 | 说明 | |------|------| diff --git a/packages/submit-bar/en-US.md b/packages/submit-bar/en-US.md index ed721dfae..33178f203 100644 --- a/packages/submit-bar/en-US.md +++ b/packages/submit-bar/en-US.md @@ -60,7 +60,7 @@ Use slot to add custom contents. ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -75,13 +75,13 @@ Use slot to add custom contents. | decimal-length | Number of digits to appear after the decimal point | `Number` | `2` | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | `Boolean` | `false` | -### Event +### Events | Event | Description | Arguments | |------|------|------| | submit | Triggerd when click submit button | - | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/submit-bar/zh-CN.md b/packages/submit-bar/zh-CN.md index ae8a6bbc2..b142befbf 100644 --- a/packages/submit-bar/zh-CN.md +++ b/packages/submit-bar/zh-CN.md @@ -63,7 +63,7 @@ Vue.use(SubmitBar); ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -78,13 +78,13 @@ Vue.use(SubmitBar); | decimal-length | 价格小数点后位数 | `Number` | `2` | 1.6.15 | | safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `Boolean` | `false` | 1.6.15 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| | submit | 按钮点击事件回调 | - | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/swipe-cell/en-US.md b/packages/swipe-cell/en-US.md index 52d6076c8..cc674d1ae 100644 --- a/packages/swipe-cell/en-US.md +++ b/packages/swipe-cell/en-US.md @@ -56,7 +56,7 @@ export default { } ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -65,7 +65,7 @@ export default { | on-close | Callback function before close | `Function` | - | | disabled | Whether to disabled swipe | `Boolean` | `false` | -### Slot +### Slots | Name | Description | |------|------| @@ -73,7 +73,7 @@ export default { | left | content of left scrollable area | | right | content of right scrollabe area | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/swipe-cell/zh-CN.md b/packages/swipe-cell/zh-CN.md index 42a2ceb3c..9ea6133ab 100644 --- a/packages/swipe-cell/zh-CN.md +++ b/packages/swipe-cell/zh-CN.md @@ -56,7 +56,7 @@ export default { } ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -65,7 +65,7 @@ export default { | on-close | 关闭时的回调函数 | `Function` | - | - | | disabled | 是否禁用滑动 | `Boolean` | `false` | 1.3.4 | -### Slot +### Slots | 名称 | 说明 | |------|------| @@ -73,7 +73,7 @@ export default { | left | 左侧滑动内容 | | right | 右侧滑动内容 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/swipe/en-US.md b/packages/swipe/en-US.md index 2e3dd7446..84e12339d 100644 --- a/packages/swipe/en-US.md +++ b/packages/swipe/en-US.md @@ -118,7 +118,7 @@ export default { } ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -133,7 +133,7 @@ export default { | width | Set Swiper Item Width | `Number` | `0` | | height | Set Swiper Item Height | `Number` | `0` | -### Event +### Events | Event | Description | Arguments | |------|------|------| @@ -147,7 +147,7 @@ Use ref to get swipe instance and call instance methods |------|------|------|------| | swipeTo | index: target index | void | Swipe to target index | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/swipe/zh-CN.md b/packages/swipe/zh-CN.md index 3414cac25..1852c5cc3 100644 --- a/packages/swipe/zh-CN.md +++ b/packages/swipe/zh-CN.md @@ -118,7 +118,7 @@ export default { } ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -153,7 +153,7 @@ export default { |------|------|------|------| | swipeTo | index: 目标位置的索引 | void | 滚动到目标位置 | -### Slot +### Slots | 名称 | 说明 | |------|------| diff --git a/packages/switch-cell/en-US.md b/packages/switch-cell/en-US.md index 13fabcb49..f5a6058e8 100644 --- a/packages/switch-cell/en-US.md +++ b/packages/switch-cell/en-US.md @@ -50,7 +50,7 @@ use `loading` property to keep component in loading state ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -66,7 +66,7 @@ use `loading` property to keep component in loading state | active-value | Value when active | `any` | `true` | | inactive-value | Value when inactive | `any` | `false` | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/switch-cell/zh-CN.md b/packages/switch-cell/zh-CN.md index e712b4687..b94a76e91 100644 --- a/packages/switch-cell/zh-CN.md +++ b/packages/switch-cell/zh-CN.md @@ -49,7 +49,7 @@ export default { ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -65,7 +65,7 @@ export default { | active-value | 打开时的值 | `any` | `true` | 1.5.6 | | inactive-value | 关闭时的值 | `any` | `false` | 1.5.6 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/switch/en-US.md b/packages/switch/en-US.md index 9fab96058..e01eb9bdc 100644 --- a/packages/switch/en-US.md +++ b/packages/switch/en-US.md @@ -92,7 +92,7 @@ export default { }; ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -105,7 +105,7 @@ export default { | active-value | Value when active | `any` | `true` | | inactive-value | Value when inactive | `any` | `false` | -### Event +### Events | Event | Description | Parameters | |------|------|------| diff --git a/packages/switch/zh-CN.md b/packages/switch/zh-CN.md index 022b1f967..539c1cc06 100644 --- a/packages/switch/zh-CN.md +++ b/packages/switch/zh-CN.md @@ -92,7 +92,7 @@ export default { }; ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -105,7 +105,7 @@ export default { | active-value | 打开时的值 | `any` | `true` | 1.5.6 | | inactive-value | 关闭时的值 | `any` | `false` | 1.5.6 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/tab/en-US.md b/packages/tab/en-US.md index 8ddf2f2cd..9f46df5e4 100644 --- a/packages/tab/en-US.md +++ b/packages/tab/en-US.md @@ -146,7 +146,7 @@ In swipeable mode, you can switch tabs with swipe gestrue in the content ``` -### Tabs API +### Tabs Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -167,28 +167,28 @@ In swipeable mode, you can switch tabs with swipe gestrue in the content | ellipsis | Whether to ellipsis too long title | `Boolean` | `true` | | lazy-render | Whether to enable tab content lazy render | `Boolean` | `true` | -### Tab API +### Tab Props | Attribute | Description | Type | Default | |------|------|------|------| | title | Title | `String` | - | | disabled | Whether to disable tab | `Boolean` | `false` | -### Tabs Slot +### Tabs Slots | Name | Description | |------|------| | nav-left | Custom nav left content | | nav-right | Custom nav right content | -### Tab Slot +### Tab Slots | Name | Description | |------|------| | default | Content of tab | | title | Custom tab title | -### Tabs Event +### Tabs Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/tab/zh-CN.md b/packages/tab/zh-CN.md index 67d4dfdd4..7e20fa872 100644 --- a/packages/tab/zh-CN.md +++ b/packages/tab/zh-CN.md @@ -150,7 +150,7 @@ export default { ``` -### Tabs API +### Tabs Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -171,28 +171,28 @@ export default { | ellipsis | 是否省略过长的标题文字 | `Boolean` | `true` | 1.5.0 | | lazy-render | 是否开启标签页内容延迟渲染 | `Boolean` | `true` | 1.6.6 | -### Tab API +### Tab Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| | title | 标题 | `String` | - | - | | disabled | 是否禁用标签 | `Boolean` | `false` | - | -### Tabs Slot +### Tabs Slots | 名称 | 说明 | |------|------| | nav-left | 标题左侧内容 | | nav-right | 标题右侧内容 | -### Tab Slot +### Tab Slots | 名称 | 说明 | |------|------| | default | 标签页内容 | | title | 自定义标签 | -### Tabs Event +### Tabs Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/tabbar/en-US.md b/packages/tabbar/en-US.md index 6fcd3c19a..6b0f745ec 100644 --- a/packages/tabbar/en-US.md +++ b/packages/tabbar/en-US.md @@ -63,7 +63,7 @@ export default { } ``` -### Tabbar API +### Tabbar Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -73,13 +73,13 @@ export default { | active-color | Color of active tab item | `String` | `#1989fa` | | safe-area-inset-bottom | Whether to enable bottom safe area adaptation, to enable those features use `viewport-fit=cover` in the `viewport` meta tag | `Boolean` | `false` | -### Tabbar Event +### Tabbar Events | Event | Description | Arguments | |------|------|------| | change | Triggered when change active tab | active: index of current tab | -### TabbarItem API +### TabbarItem Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -90,7 +90,7 @@ export default { | 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` | -### TabbarItem Slot +### TabbarItem Slots | Name | Description | slot-scope | |------|------|------| diff --git a/packages/tabbar/zh-CN.md b/packages/tabbar/zh-CN.md index cd2a50d3c..09d4ed21d 100644 --- a/packages/tabbar/zh-CN.md +++ b/packages/tabbar/zh-CN.md @@ -78,7 +78,7 @@ export default { ``` -### Tabbar API +### Tabbar Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -88,13 +88,13 @@ export default { | active-color | 选中标签的颜色 | `String` | `#1989fa` | 1.5.1 | | safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配，需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `Boolean` | `false` | 1.6.15 | -### Tabbar Event +### Tabbar Events | 事件名 | 说明 | 回调参数 | |------|------|------| | change | 切换标签时触发 | active: 当前选中标签 | -### TabbarItem API +### TabbarItem Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -105,7 +105,7 @@ export default { | to | 路由跳转对象，同 `vue-router` 的 to | `String | Object` | - | - | | replace | 跳转时是否替换当前页面历史 | `Boolean` | `false` | - | -### TabbarItem Slot +### TabbarItem Slots | 名称 | 说明 | slot-scope | |------|------|------| diff --git a/packages/tag/en-US.md b/packages/tag/en-US.md index 75f0ba100..46c4a41a0 100644 --- a/packages/tag/en-US.md +++ b/packages/tag/en-US.md @@ -63,7 +63,7 @@ Vue.use(Tag); Tag ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -76,13 +76,13 @@ Vue.use(Tag); | text-color | Text color | `String` | `white` | -### Slot +### Slots | Name | Description | |------|------| | default | Default slot | -### Event +### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/tag/zh-CN.md b/packages/tag/zh-CN.md index 9ec24a432..240f741f3 100644 --- a/packages/tag/zh-CN.md +++ b/packages/tag/zh-CN.md @@ -71,7 +71,7 @@ Vue.use(Tag); 标签 ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -83,13 +83,13 @@ Vue.use(Tag); | mark | 是否为标记样式 | `Boolean` | `false` | - | | text-color | 文本颜色，优先级高于`color`属性 | `String` | `white` | 1.5.0 | -### Slot +### Slots | 名称 | 说明 | |------|------| | default | 自定义 Tag 显示内容 | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/tree-select/en-US.md b/packages/tree-select/en-US.md index 023ca6d4c..e439f06db 100644 --- a/packages/tree-select/en-US.md +++ b/packages/tree-select/en-US.md @@ -43,9 +43,9 @@ export default { } ``` -### API +### Props -#### API +#### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -54,7 +54,7 @@ export default { | main-Active-index | The index of selected parent node | `Number` | `0` | | active-id | Id of selected item | `String | Number` | `0` | -#### Event +#### Events | Event | Description | Arguments | |------|------|------| diff --git a/packages/tree-select/zh-CN.md b/packages/tree-select/zh-CN.md index d57b5b5dc..44e56fc2e 100644 --- a/packages/tree-select/zh-CN.md +++ b/packages/tree-select/zh-CN.md @@ -43,7 +43,7 @@ export default { } ``` -### API +### Props #### 传入参数 diff --git a/packages/uploader/en-US.md b/packages/uploader/en-US.md index 4f82c811a..a625c6be2 100644 --- a/packages/uploader/en-US.md +++ b/packages/uploader/en-US.md @@ -57,7 +57,7 @@ You can set native properties such as `accpet`、`multiple` on Uploader, and the ``` -### API +### Props | Attribute | Description | Type | Default | |------|------|------|------| @@ -69,13 +69,13 @@ You can set native properties such as `accpet`、`multiple` on Uploader, and the | after-read | Hook after reading the file | `Function` | - | | max-size | Max size of file | `Number` | - | -### Event +### Events | Event | Description | Arguments | |------|------|------| | oversize | Triggered when file size over limit | Same as after-read | -### Slot +### Slots | Name | Description | |------|------| diff --git a/packages/uploader/zh-CN.md b/packages/uploader/zh-CN.md index 676bc3fb3..8992f1203 100644 --- a/packages/uploader/zh-CN.md +++ b/packages/uploader/zh-CN.md @@ -55,7 +55,7 @@ export default { ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -67,13 +67,13 @@ export default { | after-read | 读取完成后的回调函数 | `Function` | - | - | | max-size | 文件大小限制，单位为 byte | `Number` | - | - | -### Event +### Events | 事件名 | 说明 | 回调参数 | |------|------|------| | oversize | 文件大小超过限制时触发 | 同 after-read | -### Slot +### Slots | 名称 | 说明 | |------|------|