docs: add version tip in en docs (#4262)

This commit is contained in:
neverland 2019-08-27 19:56:30 +08:00 committed by GitHub
parent 8ee0bef715
commit 959efb0ce6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
88 changed files with 865 additions and 864 deletions

View File

@ -93,20 +93,20 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| actions | Options | `Action[]` | `[]` |
| title | Title | `string` | - |
| cancel-text | Text of cancel button | `string` | - |
| overlay | Whether to show overlay | `boolean` | `true` |
| round | Whether to show round corner | `boolean` | `false` |
| close-on-click-action | Whether to close when click action | `boolean` | `false` |
| close-on-click-overlay | Whether to close when click overlay | `boolean` | `true` |
| lazy-render | Whether to lazy render util appeared | `boolean` | `true` |
| lock-scroll | Whether to lock background scroll | `boolean` | `true` |
| duration | Transition duration, unit second | `number` | `0.3` |
| 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` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| actions | Options | `Action[]` | `[]` | - |
| title | Title | `string` | - | - |
| cancel-text | Text of cancel button | `string` | - | - |
| overlay | Whether to show overlay | `boolean` | `true` | - |
| round | Whether to show round corner | `boolean` | `false` | 2.0.9 |
| close-on-click-action | Whether to close when click action | `boolean` | `false` | - |
| close-on-click-overlay | Whether to close when click overlay | `boolean` | `true` | - |
| lazy-render | Whether to lazy render util appeared | `boolean` | `true` | - |
| lock-scroll | Whether to lock background scroll | `boolean` | `true` | - |
| duration | Transition duration, unit second | `number` | `0.3` | 2.0.3 |
| 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` | - |
### Events

View File

@ -114,10 +114,10 @@ export default {
| cancel-text | 取消按钮文字 | `string` | - | - |
| overlay | 是否显示遮罩层 | `boolean` | `true` | - |
| round | 是否显示圆角 | `boolean` | `false` | 2.0.9 |
| close-on-click-action | 是否在点击选项后关闭 | `boolean` | `false` | 2.0.0 |
| close-on-click-action | 是否在点击选项后关闭 | `boolean` | `false` | - |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | `boolean` | `true` | - |
| lazy-render | 是否在显示弹层时才渲染节点 | `boolean` | `true` | - |
| lock-scroll | 是否锁定背景滚动 | `boolean` | `true` | 2.0.0 |
| lock-scroll | 是否锁定背景滚动 | `boolean` | `true` | - |
| duration | 动画时长,单位秒 | `number` | `0.3` | 2.0.3 |
| get-container | 指定挂载的节点,可以传入选择器,<br>或一个返回节点的函数 | `string | () => HTMLElement` | - | - |
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配,需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `boolean` | `false` | - |

View File

@ -61,24 +61,24 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| area-list | Area List | `object` | - |
| address-info | Address Info | `AddressInfo` | `{}` |
| search-result | Address search result | `SearchResult[]` | `[]` |
| show-postal | Whether to show postal field | `boolean` | `false` |
| show-delete | Whether to show delete button | `boolean` | `false` |
| show-set-default | Whether to show default address switch | `boolean` | `false` |
| show-search-result | Whether to show address search result | `boolean` | `false` |
| save-button-text | Save button text | `string` | `Save` |
| delete-button-text | Delete button text | `string` | `Delete` |
| detail-rows | Detail input rows | `number` | `1` |
| detail-maxlength | Detail maxlength | `number` | `200` |
| is-saving | Whether to show save button loading status | `boolean` | `false` |
| is-deleting | Whether to show delete button loading status | `boolean` | `false` |
| tel-validator | The method to validate tel | `(tel: string) => boolean` | - |
| postal-validator | The method to validate postal | `(tel: string) => boolean` | - |
| validator | Custom validator | `(key, value) => string` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| area-list | Area List | `object` | - | - |
| address-info | Address Info | `AddressInfo` | `{}` | - |
| search-result | Address search result | `SearchResult[]` | `[]` | - |
| show-postal | Whether to show postal field | `boolean` | `false` | - |
| show-delete | Whether to show delete button | `boolean` | `false` | - |
| show-set-default | Whether to show default address switch | `boolean` | `false` | - |
| show-search-result | Whether to show address search result | `boolean` | `false` | - |
| save-button-text | Save button text | `string` | `Save` | - |
| delete-button-text | Delete button text | `string` | `Delete` | - |
| detail-rows | Detail input rows | `number` | `1` | - |
| detail-maxlength | Detail maxlength | `number` | `200` | 2.0.4 |
| is-saving | Whether to show save button loading status | `boolean` | `false` | - |
| is-deleting | Whether to show delete button loading status | `boolean` | `false` | - |
| tel-validator | The method to validate tel | `(tel: string) => boolean` | - | - |
| postal-validator | The method to validate postal | `(tel: string) => boolean` | - | 2.1.2 |
| validator | Custom validator | `(key, value) => string` | - | - |
### Events

View File

@ -69,14 +69,14 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Id of chosen address | `string` | - |
| list | Address list | `Address[]` | `[]` |
| disabled-list | Disabled address list | `Address[]` | `[]` |
| disabled-text | Disabled text | `string` | - |
| switchable | Whether to allow switch address | `boolean` | `true` |
| add-button-text | Add button text | `string` | `Add new address` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Id of chosen address | `string` | - | - |
| list | Address list | `Address[]` | `[]` | - |
| disabled-list | Disabled address list | `Address[]` | `[]` | - |
| disabled-text | Disabled text | `string` | - | - |
| switchable | Whether to allow switch address | `boolean` | `true` | - |
| add-button-text | Add button text | `string` | `Add new address` | - |
### Events

View File

@ -44,18 +44,18 @@ Set `columns-num` with 2, you'll have a 2 level picker.
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| value | the `code` of selected area | `string` | - |
| title | Toolbar title | `string` | - |
| area-list | Area data | `object` | - |
| columns-num | level of picker | `string | number` | `3` |
| item-height | Option height | `number` | `44` |
| loading | Whether to show loading prompt | `boolean` | `false` |
| visible-item-count | Count of visible columns | `number` | `5` |
| confirm-button-text | Text of confirm button | `string` | `Confirm` |
| cancel-button-text | Text of cancel button | `string` | `Cancel` |
| is-oversea-code | The method to validate oversea code | `() => boolean` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| value | the `code` of selected area | `string` | - | - |
| title | Toolbar title | `string` | - | - |
| area-list | Area data | `object` | - | - |
| columns-num | level of picker | `string | number` | `3` | - |
| item-height | Option height | `number` | `44` | - |
| loading | Whether to show loading prompt | `boolean` | `false` | - |
| visible-item-count | Count of visible columns | `number` | `5` | - |
| confirm-button-text | Text of confirm button | `string` | `Confirm` | - |
| cancel-button-text | Text of cancel button | `string` | `Cancel` | - |
| is-oversea-code | The method to validate oversea code | `() => boolean` | - | 2.1.4 |
### Events

View File

@ -92,27 +92,27 @@ Vue.use(Button);
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Can be set to `primary` `info` `warning` `danger` | `string` | `default` |
| size | Can be set to `large` `small` `mini` | `string` | `normal` |
| text | Text | `string` | - |
| color | Color, support linear-gradient | `string` | - |
| icon | Left Icon | `string` | - |
| tag | HTML Tag | `string` | `button` |
| native-type | Native Type Attribute | `string` | `''` |
| plain | Whether to be plain button | `boolean` | `false` |
| block | Whether to set display block | `boolean` | `false` |
| round | Whether to be round button | `boolean` | `false` |
| square | Whether to be square button | `boolean` | `false` |
| disabled | Whether to disable button | `boolean` | `false` |
| loading | Whether show loading status | `boolean` | `false` |
| loading-text | Loading text | `string` | - |
| loading-type | Loading type, can be set to `spinner` | `string` | `circular` |
| loading-size | Loading icon size | `string` | `20px` |
| url | Link URL | `string` | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| type | Can be set to `primary` `info` `warning` `danger` | `string` | `default` | - |
| size | Can be set to `large` `small` `mini` | `string` | `normal` | - |
| text | Text | `string` | - | - |
| color | Color, support linear-gradient | `string` | - | 2.1.3 |
| icon | Left Icon | `string` | - | - |
| tag | HTML Tag | `string` | `button` | - |
| native-type | Native Type Attribute | `string` | `''` | - |
| plain | Whether to be plain button | `boolean` | `false` | - |
| block | Whether to set display block | `boolean` | `false` | - |
| round | Whether to be round button | `boolean` | `false` | - |
| square | Whether to be square button | `boolean` | `false` | - |
| disabled | Whether to disable button | `boolean` | `false` | - |
| loading | Whether show loading status | `boolean` | `false` | - |
| loading-text | Loading text | `string` | - | - |
| loading-type | Loading type, can be set to `spinner` | `string` | `circular` | - |
| loading-size | Loading icon size | `string` | `20px` | - |
| url | Link URL | `string` | - | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` | - |
### Events

View File

@ -118,7 +118,7 @@ Vue.use(Button);
| size | 尺寸,可选值为 `large` `small` `mini` | `string` | `normal` | - |
| text | 按钮文字 | `string` | - | - |
| color | 按钮颜色,支持传入`linear-gradient`渐变色 | `string` | - | 2.1.3 |
| icon | 左侧图标名称或图片链接,可选值见 Icon 组件 | `string` | - | 2.0.0 |
| icon | 左侧图标名称或图片链接,可选值见 Icon 组件 | `string` | - | - |
| tag | HTML 标签 | `string` | `button` | - |
| native-type | 原生 button 标签 type 属性 | `string` | - | - |
| block | 是否为块级元素 | `boolean` | `false` | - |
@ -129,7 +129,7 @@ Vue.use(Button);
| hairline | 是否使用 0.5px 边框 | `boolean` | `false` | - |
| loading | 是否显示为加载状态 | `boolean` | `false` | - |
| loading-text | 加载状态提示文字 | `string` | - | - |
| loading-type | 加载图标类型,可选值为`spinner` | `string` | `circular` | 2.0.0 |
| loading-type | 加载图标类型,可选值为`spinner` | `string` | `circular` | - |
| loading-size | 加载图标大小 | `string` | `20px` | - |
| url | 跳转链接 | `string` | - | - |
| to | 路由跳转对象,同 vue-router 的 to 属性 | `string | object` | - | - |

View File

@ -64,19 +64,19 @@ Use slot to custom content.
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| thumb | Left thumb image URL | `string` | - |
| title | Title | `string` | - |
| desc | Description | `string` | - |
| tag | Tag | `string` | - |
| num | number | `string | number` | - |
| price | Price | `string | number` | - |
| origin-price | Origin price | `string | number` | - |
| centered | Whether content vertical centered | `boolean` | `false` |
| currency | Currency symbol | `string` | `¥` |
| thumb-link | Thumb link URL | `string` | - |
| lazy-load | Whether to enable thumb lazy loadshould register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| thumb | Left thumb image URL | `string` | - | - |
| title | Title | `string` | - | - |
| desc | Description | `string` | - | - |
| tag | Tag | `string` | - | - |
| num | number | `string | number` | - | - |
| price | Price | `string | number` | - | - |
| origin-price | Origin price | `string | number` | - | - |
| centered | Whether content vertical centered | `boolean` | `false` | - |
| currency | Currency symbol | `string` | `¥` | - |
| thumb-link | Thumb link URL | `string` | - | - |
| lazy-load | Whether to enable thumb lazy loadshould register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` | - |
### Events

View File

@ -98,33 +98,33 @@ Vue.use(Cell).use(CellGroup);
### CellGroup Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Group title | `string` | - |
| border | Whether to show outer border | `boolean` | `true` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| title | Group title | `string` | - | - |
| border | Whether to show outer border | `boolean` | `true` | - |
### Cell Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| icon | Left Icon | `string` | - |
| title | Title | `string | number` | - |
| value | Right text | `string | number` | - |
| label | Description below the title | `string` | - |
| size | Sizecan be set to `large` | `string` | - |
| border | Whether to show inner border | `boolean` | `true` |
| center | Whether to center content vertically | `boolean` | `true` |
| url | Link URL | `string` | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` |
| clickable | Whether to show click feedback when clicked | `boolean` | `false` |
| is-link | Whether to show link icon | `boolean` | `false` |
| required | Whether to show required mark | `boolean` | `false` |
| arrow-direction | Can be set to `left` `up` `down` | `string` | - |
| title-style | Title style | `any` | - |
| title-class | Title className | `any` | - |
| value-class | Value className | `any` | - |
| label-class | Label className | `any` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| icon | Left Icon | `string` | - | - |
| title | Title | `string | number` | - | - |
| value | Right text | `string | number` | - | - |
| label | Description below the title | `string` | - | - |
| size | Sizecan be set to `large` | `string` | - | - |
| border | Whether to show inner border | `boolean` | `true` | - |
| center | Whether to center content vertically | `boolean` | `true` | - |
| url | Link URL | `string` | - | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` | - |
| clickable | Whether to show click feedback when clicked | `boolean` | `false` | - |
| is-link | Whether to show link icon | `boolean` | `false` | - |
| required | Whether to show required mark | `boolean` | `false` | - |
| arrow-direction | Can be set to `left` `up` `down` | `string` | - | - |
| title-style | Title style | `any` | - | - |
| title-class | Title className | `any` | - | - |
| value-class | Value className | `any` | - | - |
| label-class | Label className | `any` | - | - |
### Cell Events

View File

@ -143,24 +143,24 @@ export default {
### Checkbox Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Checkbox name | `any` | - |
| shape | Can be set to `square` | `string` | `round` |
| v-model | Check status | `boolean` | `false` |
| disabled | Diable checkbox | `boolean` | `false` |
| icon-size | Icon size | `string | number` | `20px` |
| label-disabled | Whether to disable label click | `boolean` | `false` |
| label-position | Can be set to `left` | `string` | `right` |
| checked-color | Checked color | `string` | `#1989fa` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Checkbox name | `any` | - | - |
| shape | Can be set to `square` | `string` | `round` | - |
| v-model | Check status | `boolean` | `false` | - |
| disabled | Diable checkbox | `boolean` | `false` | - |
| icon-size | Icon size | `string | number` | `20px` | - |
| label-disabled | Whether to disable label click | `boolean` | `false` | - |
| label-position | Can be set to `left` | `string` | `right` | - |
| checked-color | Checked color | `string` | `#1989fa` | - | - |
### CheckboxGroup Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Names of all checked checkboxes | `any[]` | - |
| disabled | Disable all checkboxes | `boolean` | `false` |
| max | Maximum amount of checked options | `number` | `0`(Unlimited) |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Names of all checked checkboxes | `any[]` | - | - |
| disabled | Disable all checkboxes | `boolean` | `false` | - |
| max | Maximum amount of checked options | `number` | `0`(Unlimited) | - |
### Checkbox Events

View File

@ -153,7 +153,7 @@ export default {
| shape | 形状,可选值为 `square` | `string` | `round` | - |
| v-model | 是否为选中状态 | `boolean` | `false` | - |
| disabled | 是否禁用复选框 | `boolean` | `false` | - |
| icon-size | 图标大小,默认单位为`px` | `string | number` | `20px` | 2.0.0 |
| icon-size | 图标大小,默认单位为`px` | `string | number` | `20px` | - |
| label-disabled | 是否禁用复选框文本点击 | `boolean` | `false` | - |
| label-position | 文本位置,可选值为 `left` | `string` | `right` | - |
| checked-color | 选中状态颜色 | `string` | `#1989fa` | - |

View File

@ -110,18 +110,18 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current rate | `number` | - |
| rate | Target rate | `number` | `100` |
| size | Circle size | `string | number` | `100px` |
| color | Progress color, passing object to render gradient | `string | object` | `#1989fa` |
| layer-color | Layer color | `string` | `#fff` |
| fill | Fill color | `string` | `none` |
| speed | Animate speedrate/s| `number` | `0` |
| text | Text | `string` | - |
| stroke-width | Stroke width | `number` | `40` |
| clockwise | Is clockwise | `boolean` | `true` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Current rate | `number` | - | - |
| rate | Target rate | `number` | `100` | - |
| size | Circle size | `string | number` | `100px` | - |
| color | Progress color, passing object to render gradient | `string | object` | `#1989fa` | 2.1.4 |
| layer-color | Layer color | `string` | `#fff` | - |
| fill | Fill color | `string` | `none` | - |
| speed | Animate speedrate/s| `number` | `0` | - |
| text | Text | `string` | - | - |
| stroke-width | Stroke width | `number` | `40` | - |
| clockwise | Is clockwise | `boolean` | `true` | - |
### Slots

View File

@ -91,21 +91,21 @@ Setting `type` to `flex` to enable flex layout
### Row Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Layout type, can be set to `flex` | `string` | - |
| gutter | Grid spacingpx | `string | number` | - |
| tag | Custom element tag | `string` | `div` |
| justify | Flex main axiscan be set to end/center/space-around/space-between | `string` | `start` |
| align | Flex cross axis, be set to center/bottom | `string` | `top` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| type | Layout type, can be set to `flex` | `string` | - | - |
| gutter | Grid spacingpx | `string | number` | - | - |
| tag | Custom element tag | `string` | `div` | - |
| justify | Flex main axiscan be set to end/center/space-around/space-between | `string` | `start` | - |
| align | Flex cross axis, be set to center/bottom | `string` | `top` | - |
### Col Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| span | number of column the grid spans | `string | number` | - |
| offset | number of spacing on the left side of the grid | `string | number` | - |
| tag | Custom element tag | `string` | `div` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| span | number of column the grid spans | `string | number` | - | - |
| offset | number of spacing on the left side of the grid | `string | number` | - | - |
| tag | Custom element tag | `string` | `div` | - |
### Row Events

View File

@ -87,11 +87,11 @@ export default {
### Collapse Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Names of current active panels | `(string | number)[] `(non-accordion mode)<br>`string | number`(accordion mode) | - |
| accordion | Whether to be accordion mode | `boolean` | `false` |
| border | Whether to show outer border | `boolean` | `true` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Names of current active panels | `(string | number)[] `(non-accordion mode)<br>`string | number`(accordion mode) | - | - |
| accordion | Whether to be accordion mode | `boolean` | `false` | - |
| border | Whether to show outer border | `boolean` | `true` | - |
### Collapse Events
@ -101,20 +101,20 @@ export default {
### CollapseItem Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Name | `string | number` | `index` |
| icon | Left Icon | `string` | - |
| size | Title sizecan be set to `large` | `string` | - |
| title | Title | `string | number` | - |
| value | Right text | `string | number` | - |
| label | Description below the title | `string` | - |
| border | Whether to show inner border | `boolean` | `true` |
| disabled | Whether to disabled collapse | `boolean` | `false` |
| is-link | Whether to show link icon | `boolean` | `true` |
| title-class | Title className | `string` | - |
| value-class | Value className | `string` | - |
| label-class | Label className | `string` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Name | `string | number` | `index` | - |
| icon | Left Icon | `string` | - | - |
| size | Title sizecan be set to `large` | `string` | - | - |
| title | Title | `string | number` | - | - |
| value | Right text | `string | number` | - | - |
| label | Description below the title | `string` | - | - |
| border | Whether to show inner border | `boolean` | `true` | - |
| disabled | Whether to disabled collapse | `boolean` | `false` | - |
| is-link | Whether to show link icon | `boolean` | `true` | - |
| title-class | Title className | `string` | - | - |
| value-class | Value className | `string` | - | - |
| label-class | Label className | `string` | - | - |
### CollapseItem Slots

View File

@ -103,7 +103,7 @@ export default {
### CollapseItem Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|------|
|------|------|------|------|------|
| name | 唯一标识符,默认为索引值 | `string | number` | `index` | - |
| icon | 标题栏左侧图标名称或图片链接,可选值见 Icon 组件 | `string` | - | - |
| size | 标题栏大小,可选值为 `large` | `string` | - | - |

View File

@ -135,12 +135,12 @@ export default {
### ContactCard Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Can be set to `add` `edit` | `string` | `add` |
| name | Name | `string` | - |
| tel | Phone | `string` | - |
| add-text | Add card text | `string` | `Add contact info` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| type | Can be set to `add` `edit` | `string` | `add` | - |
| name | Name | `string` | - | - |
| tel | Phone | `string` | - | - |
| add-text | Add card text | `string` | `Add contact info` | - |
### ContactCard Events
@ -150,11 +150,11 @@ export default {
### ContactList Props
| Attribute | Description | Type | Default |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Id of chosen contact | `string | number` | - |
| list | Contact list | `Contact[]` | `[]` |
| add-text | Add button text | `string` | `Add new contact` |
| v-model | Id of chosen contact | `string | number` | - | - |
| list | Contact list | `Contact[]` | `[]` | - |
| add-text | Add button text | `string` | `Add new contact` | - |
### ContactList Events
@ -166,13 +166,13 @@ export default {
### ContactEdit Props
| Attribute | Description | Type | Default |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| contact-info | Contact Info | `object` | `[]` |
| is-edit | Whether is editing | `boolean` | `false` |
| is-saving | Whether to show save button loading status | `boolean` | `false` |
| is-deleting | Whether to show delete button loading status | `boolean` | `false` |
| tel-validator | The method to validate tel | `(tel: string) => boolean` | - |
| contact-info | Contact Info | `object` | `[]` | - |
| is-edit | Whether is editing | `boolean` | `false` | - |
| is-saving | Whether to show save button loading status | `boolean` | `false` | - |
| is-deleting | Whether to show delete button loading status | `boolean` | `false` | - |
| tel-validator | The method to validate tel | `(tel: string) => boolean` | - | - |
### ContactEdit Events

View File

@ -111,12 +111,12 @@ export default {
### Props
| Attribute | Description | Type | Default |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| time | Total time | `number` | - |
| format | Time formatDD-dayHH-hourmm-minutess-secondSSS-millisecond | `string` | `HH:mm:ss` |
| auto-start | Whether to auto start count down | `boolean` | `true` |
| millisecond | Whether to enable millisecond render | `boolean` | `false` |
| time | Total time | `number` | - | - |
| format | Time formatDD-dayHH-hourmm-minutess-secondSSS-millisecond | `string` | `HH:mm:ss` | - |
| auto-start | Whether to auto start count down | `boolean` | `true` | - |
| millisecond | Whether to enable millisecond render | `boolean` | `false` | - |
### Events

View File

@ -71,34 +71,34 @@ export default {
### CouponCell Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Cell title | `string` | `Coupon` |
| chosen-coupon | Index of chosen coupon | `number` | `-1` |
| coupons | Coupon list | `Coupon[]` | `[]` |
| editable | Cell editable | `boolean` | `true` |
| border | Whether to show innner border | `boolean` | `true` |
| currency | Currency symbol | `string` | `¥` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| title | Cell title | `string` | `Coupon` | - |
| chosen-coupon | Index of chosen coupon | `number` | `-1` | - |
| coupons | Coupon list | `Coupon[]` | `[]` | - |
| editable | Cell editable | `boolean` | `true` | - |
| border | Whether to show innner border | `boolean` | `true` | - |
| currency | Currency symbol | `string` | `¥` | - |
### CouponList Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current exchange code | `string` | - |
| chosen-coupon | Index of chosen coupon | `number` | `-1` |
| coupons | Coupon list | `Coupon[]` | `[]` |
| disabled-coupons | Disabled coupon list | `Coupon[]` | `[]` |
| enabled-title | Title of coupon list | `string` | `Available` | - |
| disabled-title | Title of disabled coupon list | `string` | `Unavailable` | - |
| exchange-button-text | Exchange button text | `string` | `Exchange` |
| exchange-button-loading | Whether to show loading in exchange button | `boolean` | `false` |
| exchange-button-disabled | Whether to disable exchange button | `boolean` | `false` |
| exchange-min-length | Min length to enable exchange button | `number` | `1` |
| displayed-coupon-index | Index of displayed coupon | `number` | - |
| close-button-text | Close button text | `string` | `Close` |
| input-placeholder | Input placeholder | `string` | `Coupon code` |
| currency | Currency symbol | `string` | `¥` |
| empty-image | Placeholder image when list is empty | `string` | `https://img.yzcdn.cn/vant/coupon-empty.png` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Current exchange code | `string` | - | - |
| chosen-coupon | Index of chosen coupon | `number` | `-1` | - |
| coupons | Coupon list | `Coupon[]` | `[]` | - |
| disabled-coupons | Disabled coupon list | `Coupon[]` | `[]` | - |
| enabled-title | Title of coupon list | `string` | `Available` | - | - |
| disabled-title | Title of disabled coupon list | `string` | `Unavailable` | - | - |
| exchange-button-text | Exchange button text | `string` | `Exchange` | - |
| exchange-button-loading | Whether to show loading in exchange button | `boolean` | `false` | - |
| exchange-button-disabled | Whether to disable exchange button | `boolean` | `false` | - |
| exchange-min-length | Min length to enable exchange button | `number` | `1` | - |
| displayed-coupon-index | Index of displayed coupon | `number` | - | - |
| close-button-text | Close button text | `string` | `Close` | - |
| input-placeholder | Input placeholder | `string` | `Coupon code` | - |
| currency | Currency symbol | `string` | `¥` | - |
| empty-image | Placeholder image when list is empty | `string` | `https://img.yzcdn.cn/vant/coupon-empty.png` | - |
### CouponList Events

View File

@ -147,23 +147,23 @@ export default {
### Props
| Attribute | Description | Type | Default |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| type | Can be set to `date` `time`<br> `year-month` | `string` | `datetime` |
| min-date | Min date | `Date` | Ten years ago on January 1 |
| max-date | Max date | `Date` | Ten years later on December 31 |
| min-hour | Min hour for `time` type | `number` | `0` |
| max-hour | Max hour for `time` type | `number` | `23` |
| min-minute | Max minute for `time` type | `number` | `0` |
| max-minute | Max minute for `time` type | `number` | `59` |
| filter | Option filter | `(type, values) => values` | - |
| formatter | Option text formatter | `(type, value) => value` | - |
| title | Toolbar title | `string` | `''` |
| loading | Whether to show loading prompt | `boolean` | `false` |
| item-height | Option height | `number` | `44` |
| confirm-button-text | Text of confirm button | `string` | `Confirm` |
| cancel-button-text | Text of cancel button | `string` | `Cancel` |
| visible-item-count | Count of visible columns | `number` | `5` |
| type | Can be set to `date` `time`<br> `year-month` | `string` | `datetime` | - |
| min-date | Min date | `Date` | Ten years ago on January 1 | - |
| max-date | Max date | `Date` | Ten years later on December 31 | - |
| min-hour | Min hour for `time` type | `number` | `0` | - |
| max-hour | Max hour for `time` type | `number` | `23` | - |
| min-minute | Max minute for `time` type | `number` | `0` | - |
| max-minute | Max minute for `time` type | `number` | `59` | - |
| filter | Option filter | `(type, values) => values` | - | - |
| formatter | Option text formatter | `(type, value) => value` | - | - |
| title | Toolbar title | `string` | `''` | - |
| loading | Whether to show loading prompt | `boolean` | `false` | - |
| item-height | Option height | `number` | `44` | - |
| confirm-button-text | Text of confirm button | `string` | `Confirm` | - |
| cancel-button-text | Text of cancel button | `string` | `Cancel` | - |
| visible-item-count | Count of visible columns | `number` | `5` | - |
### Events

View File

@ -160,7 +160,7 @@ export default {
| max-hour | 可选的最大小时,针对 time 类型 | `number` | `23` | - |
| min-minute | 可选的最小分钟,针对 time 类型 | `number` | `0` | - |
| max-minute | 可选的最大分钟,针对 time 类型 | `number` | `59` | - |
| filter | 选项过滤函数 | `(type, values) => values` | - | 2.0.0 |
| filter | 选项过滤函数 | `(type, values) => values` | - | - |
| formatter | 选项格式化函数 | `(type, value) => value` | - | - |
| title | 顶部栏标题 | `string` | `''` | - |
| show-toolbar | 是否显示顶部栏 | `boolean` | `false` | - |

View File

@ -116,44 +116,45 @@ export default {
### Options
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Title | `string` | - |
| message | Message | `string` | - |
| messageAlign | Message text aligncan be set to `left` `right` | `string` | `center` |
| className | Custom className | `any` | - |
| showConfirmButton | Whether to show confirm button | `boolean` | `true` |
| showCancelButton | Whether to show cancel button | `boolean` | `false` |
| cancelButtonText | Cancel button text | `string` | `Cancel` |
| cancelButtonColor | Cancel button color | `string` | `#000` |
| confirmButtonText | Confirm button text | `string` | `Confirm` |
| confirmButtonColor | Confirm button color | `string` | `#1989fa` |
| overlay | Whether to show overlay | `boolean` | `true` |
| closeOnPopstate | Whether to close when popstate | `boolean` | `false` |
| closeOnClickOverlay | Whether to close when click overlay | `boolean` | `false` |
| lockScroll | Whether to lock body scroll | `boolean` | `true` |
| beforeClose | Callback before close,<br>call done() to close dialog,<br>call done(false) to cancel loading | (action: string, done: Function) => void | - |
| getContainer | Return the mount node for Dialog | `string | () => HTMLElement` | `body` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| title | Title | `string` | - | - |
| message | Message | `string` | - | - |
| messageAlign | Message text aligncan be set to `left` `right` | `string` | `center` | - |
| className | Custom className | `any` | - | - |
| showConfirmButton | Whether to show confirm button | `boolean` | `true` | - |
| showCancelButton | Whether to show cancel button | `boolean` | `false` | - |
| cancelButtonText | Cancel button text | `string` | `Cancel` | - |
| cancelButtonColor | Cancel button color | `string` | `#000` | - |
| confirmButtonText | Confirm button text | `string` | `Confirm` | - |
| confirmButtonColor | Confirm button color | `string` | `#1989fa` | - |
| overlay | Whether to show overlay | `boolean` | `true` | - |
| closeOnPopstate | Whether to close when popstate | `boolean` | `false` | 2.0.5 |
| closeOnClickOverlay | Whether to close when click overlay | `boolean` | `false` | - |
| lockScroll | Whether to lock body scroll | `boolean` | `true` | - |
| beforeClose | Callback before close,<br>call done() to close dialog,<br>call done(false) to cancel loading | (action: string, done: Function) => void | - | - |
| getContainer | Return the mount node for Dialog | `string | () => HTMLElement` | `body` | - |
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Whether to show dialog | `boolean` | - |
| title | Title | `string` | - |
| message | Message | `string` | - |
| message-align | Message aligncan be set to `left` `right` | `string` | `center` |
| show-confirm-button | Whether to show confirm button | `boolean` | `true` |
| show-cancel-button | Whether to show cancel button | `boolean` | `false` |
| cancel-button-text | Cancel button text | `string` | `Cancel` |
| cancel-button-color | Cancel button color | `string` | `#000` |
| confirm-button-text | Confirm button text | `string` | `Confirm` |
| confirm-button-color | Confirm button color | `string` | `#1989fa` |
| overlay | Whether to show overlay | `boolean` | `true` |
| close-on-click-overlay | Whether to close when click overlay | `boolean` | `false` |
| lock-scroll | Whether to lock background scroll | `boolean` | `true` |
| before-close | Callback before close,<br>call done() to close dialog,<br>call done(false) to cancel loading | (action: string, done: Function) => void | - |
| get-container | Return the mount node for Dialog | `string | () => HTMLElement` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Whether to show dialog | `boolean` | - | - |
| title | Title | `string` | - | - |
| message | Message | `string` | - | - |
| message-align | Message aligncan be set to `left` `right` | `string` | `center` | - |
| show-confirm-button | Whether to show confirm button | `boolean` | `true` | - |
| show-cancel-button | Whether to show cancel button | `boolean` | `false` | - |
| cancel-button-text | Cancel button text | `string` | `Cancel` | - |
| cancel-button-color | Cancel button color | `string` | `#000` | - |
| confirm-button-text | Confirm button text | `string` | `Confirm` | - |
| confirm-button-color | Confirm button color | `string` | `#1989fa` | - |
| overlay | Whether to show overlay | `boolean` | `true` | - |
| close-on-popstate | Whether to close when popstate | `boolean` | `false` | 2.0.5 |
| close-on-click-overlay | Whether to close when click overlay | `boolean` | `false` | - |
| lock-scroll | Whether to lock background scroll | `boolean` | `true` | - |
| before-close | Callback before close,<br>call done() to close dialog,<br>call done(false) to cancel loading | (action: string, done: Function) => void | - | - |
| get-container | Return the mount node for Dialog | `string | () => HTMLElement` | - | - |
### Events

View File

@ -181,6 +181,7 @@ export default {
| confirm-button-text | 确认按钮文案 | `string` | `确认` | - |
| confirm-button-color | 确认按钮颜色 | `string` | `#1989fa` | - |
| overlay | 是否展示遮罩层 | `boolean` | `true` | - |
| close-on-popstate | 是否在页面回退时自动关闭 | `boolean` | `false` | 2.0.5 |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | `boolean` | `false` | - |
| lock-scroll | 是否锁定背景滚动 | `boolean` | `true` | - |
| before-close | 关闭前的回调函数,<br>调用 done() 后关闭弹窗,<br>调用 done(false) 阻止弹窗关闭 | `(action, done) => void` | - | - |

View File

@ -48,13 +48,13 @@ Vue.use(Divider);
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| dashed | Whether to use dashed border | `boolean` | `false` |
| hairline | Whether to use hairline | `boolean` | `true` |
| content-position | Content positioncan be set to `left` `right` | `string` | `center` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| dashed | Whether to use dashed border | `boolean` | `false` | - |
| hairline | Whether to use hairline | `boolean` | `true` | - |
| content-position | Content positioncan be set to `left` `right` | `string` | `center` | - |
### Cell Slots
### Slots
| Name | Description |
|------|------|

View File

@ -99,25 +99,25 @@ export default {
### DropdownMenu Props
| Attribute | Description | Type | Default |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| active-color | Active color of title and option | `string` | `#1989fa` |
| z-index | z-index of menu item | `number` | `10` |
| duration | Transition duration, unit second | `number` | `0.2` |
| direction | Expand direction, can be set to `up` | `string` | `down` |
| overlay | Whether to show overlay | `boolean` | `true` |
| close-on-click-overlay | Whether to close when click overlay | `boolean` | `true` |
| close-on-click-outside | Whether to close when click outside | `boolean` | `true` |
| active-color | Active color of title and option | `string` | `#1989fa` | - |
| z-index | z-index of menu item | `number` | `10` | - |
| duration | Transition duration, unit second | `number` | `0.2` | - |
| direction | Expand direction, can be set to `up` | `string` | `down` | 2.0.1 |
| overlay | Whether to show overlay | `boolean` | `true` | - |
| close-on-click-overlay | Whether to close when click overlay | `boolean` | `true` | - |
| close-on-click-outside | Whether to close when click outside | `boolean` | `true` | 2.0.7 |
### DropdownItem Props
| Attribute | Description | Type | Default |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| value | Value of current optioncan use `v-model` | `string | number` | - |
| title | Item title | `string` | Text of selected option |
| options | Options | `Option[]` | `[]` |
| disabled | Whether to disable dropdown item | `boolean` | `false` |
| title-class | Title class | `string` | - |
| value | Value of current optioncan use `v-model` | `string | number` | - | - |
| title | Item title | `string` | Text of selected option | - |
| options | Options | `Option[]` | `[]` | - |
| disabled | Whether to disable dropdown item | `boolean` | `false` | - |
| title-class | Title class | `string` | - | - |
### DropdownItem Events

View File

@ -107,7 +107,7 @@ export default {
|------|------|------|------|------|
| active-color | 菜单标题和选项的选中态颜色 | `string` | `#1989fa` | - |
| z-index | 菜单栏 z-index 层级 | `number` | `10` | - |
| duration | 动画时长,单位秒 | `number` | `0.2` | 2.0.0 |
| duration | 动画时长,单位秒 | `number` | `0.2` | - |
| direction | 菜单展开方向,可选值为`up` | `string` | `down` | 2.0.1 |
| overlay | 是否显示遮罩层 | `boolean` | `true` | - |
| close-on-click-overlay | 是否在点击遮罩层后关闭菜单 | `boolean` | `true` | - |

View File

@ -120,34 +120,32 @@ Use button slot to insert button
### Props
Field support all native properties of input tagsuch as `maxlength``placeholder``autofocus`
| Attribute | Description | Type | Default |
|------|------|------|------|
| value | Field value | `string | number` | - |
| label | Field label | `string` | - |
| type | Input type, can be set to `tel` `number`<br>`textarea` `password` | `string` | `text` |
| size | Sizecan be set to `large` | `string` | - |
| maxlength | Max length of value | `string | number` | - |
| placeholder | Placeholder | `string` | - |
| border | Whether to show inner border | `boolean` | `true` |
| disabled | Whether to disable field | `boolean` | `false` |
| readonly | Whether to be readonly | `boolean` | `false` |
| required | Whether to show required mark | `boolean` | `false` |
| clearable | Whether to be clearable | `boolean` | `false` |
| clickable | Whether to show click feedback when clicked | `boolean` | `false` |
| is-link | Whether to show link icon | `boolean` | `false` |
| error | Whether to show error info | `boolean` | `false` |
| arrow-direction | Can be set to `left` `up` `down` | `string` | - |
| error-message | Error message | `string` | `''` |
| label-class | Label className | `any` | - |
| label-width | Label width | `string | number` | `90px` |
| label-align | Label text align, can be set to `center` `right` | `string` | `left` |
| input-align | Input text align, can be set to `center` `right` | `string` | `left` |
| error-message-align | Error message text align, can be set to `center` `right` | `string` | `left` |
| autosize | Textarea auto resizecan accpet an object,<br>e.g. { maxHeight: 100, minHeight: 50 } | `boolean | object` | `false` |
| left-icon | Left side icon name | `string` | - |
| right-icon | Right side icon name | `string` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| value | Field value | `string | number` | - | - |
| label | Field label | `string` | - | - |
| type | Input type, can be set to `tel` `number`<br>`textarea` `password` | `string` | `text` | - |
| size | Sizecan be set to `large` | `string` | - | - |
| maxlength | Max length of value | `string | number` | - | - |
| placeholder | Placeholder | `string` | - | - |
| border | Whether to show inner border | `boolean` | `true` | - |
| disabled | Whether to disable field | `boolean` | `false` | - |
| readonly | Whether to be readonly | `boolean` | `false` | - |
| required | Whether to show required mark | `boolean` | `false` | - |
| clearable | Whether to be clearable | `boolean` | `false` | - |
| clickable | Whether to show click feedback when clicked | `boolean` | `false` | - |
| is-link | Whether to show link icon | `boolean` | `false` | - |
| error | Whether to show error info | `boolean` | `false` | - |
| arrow-direction | Can be set to `left` `up` `down` | `string` | - | 2.0.4 |
| error-message | Error message | `string` | `''` | - |
| label-class | Label className | `any` | - | - |
| label-width | Label width | `string | number` | `90px` | - |
| label-align | Label text align, can be set to `center` `right` | `string` | `left` | - |
| input-align | Input text align, can be set to `center` `right` | `string` | `left` | - |
| error-message-align | Error message text align, can be set to `center` `right` | `string` | `left` | - |
| autosize | Textarea auto resizecan accpet an object,<br>e.g. { maxHeight: 100, minHeight: 50 } | `boolean | object` | `false` | - |
| left-icon | Left side icon name | `string` | - | - |
| right-icon | Right side icon name | `string` | - | - |
### Events

View File

@ -125,7 +125,7 @@ Vue.use(Field);
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|------|
|------|------|------|------|------|
| label | 输入框左侧文本 | `string` | - | - |
| value | 当前输入的值 | `string | number` | - | - |
| type | 输入框类型, 可选值为 `tel` `number`<br>`textarea` `password` 等 | `string` | `text` | - |
@ -137,12 +137,12 @@ Vue.use(Field);
| readonly | 是否只读 | `boolean` | `false` | - |
| required | 是否显示表单必填星号 | `boolean` | `false` | - |
| clearable | 是否启用清除控件 | `boolean` | `false` | - |
| clickable | 是否开启点击反馈 | `boolean` | `false` | 2.0.0 |
| clickable | 是否开启点击反馈 | `boolean` | `false` | - |
| is-link | 是否展示右侧箭头并开启点击反馈 | `boolean` | `false` | - |
| error | 是否将输入内容标红 | `boolean` | `false` | - |
| arrow-direction | 箭头方向,可选值为 `left` `up` `down` | `string` | - | 2.0.4 |
| error-message | 底部错误提示文案,为空时不展示 | `string` | `''` | -
| label-class | 左侧文本额外类名 | `any` | - | 2.0.0 |
| label-class | 左侧文本额外类名 | `any` | - | - |
| label-width | 左侧文本宽度,可指定单位,默认为 px | `string | number` | `90px` | - |
| label-align | 左侧文本对齐方式,可选值为 `center` `right` | `string` | `left` | - |
| input-align | 输入框内容对齐方式,可选值为 `center` `right` | `string` | `left` | - |

View File

@ -71,35 +71,35 @@ Use `info` prop to show messages in upper right corner of icon
### GoodsAction Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| 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` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| 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` | - |
### GoodsActionIcon Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| text | Button text | `string` | - |
| icon | Icon | `string` | - |
| icon-class | Icon class name | `any` | `''` |
| info | Info message | `string | number` | - |
| url | Link | `string` | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| text | Button text | `string` | - | - |
| icon | Icon | `string` | - | - |
| icon-class | Icon class name | `any` | `''` | - |
| info | Info message | `string | number` | - | - |
| url | Link | `string` | - | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` | - |
### GoodsActionButton Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Button type, Can be set to `primary` `info` `warning` `danger` | `string` | `default` |
| text | Button text | `string` | - |
| color | Button color, support linear-gradient | `string` | - |
| primary | Is primary button (red color) | `boolean` | `false` |
| disabled | Whether to disable button | `boolean` | `false` |
| loading | Whether show loading status | `boolean` | `false` |
| url | Link | `string` | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| text | Button text | `string` | - | - |
| type | Button type, Can be set to `primary` `info` `warning` `danger` | `string` | `default` | - |
| color | Button color, support linear-gradient | `string` | - | 2.1.8 |
| primary | Is primary button (red color) | `boolean` | `false` | - |
| disabled | Whether to disable button | `boolean` | `false` | - |
| loading | Whether show loading status | `boolean` | `false` | - |
| url | Link | `string` | - | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` | - |
### GoodsActionIcon Slots

View File

@ -94,7 +94,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| text | 按钮文字 | `string` | - | - |
| type | 按钮类型,可选值为 `primary` `info` `warning` `danger` | `string` | `default` | 2.0.0 |
| type | 按钮类型,可选值为 `primary` `info` `warning` `danger` | `string` | `default` | - |
| color | 按钮颜色,支持传入`linear-gradient`渐变色 | `string` | - | 2.1.8 |
| disabled | 是否禁用按钮 | `boolean` | `false` | - | - |
| loading | 是否显示为加载状态 | `boolean` | `false` | - | - |

View File

@ -100,24 +100,24 @@ Vue.use(Grid).use(GridItem);
### Grid Props
| Attribute | Description | Type | Default |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| column-num | Column Num | `number` | `4` |
| gutter | Gutter | `string | number` | `0` |
| border | Whether to show border | `boolean` | `true` |
| center | Whether to center content | `boolean` | `true` |
| square | Whether to be square shape | `boolean` | `false` |
| clickable | Whether to show click feedback when clicked | `boolean` | `false` |
| column-num | Column Num | `number` | `4` | 2.0.4 |
| gutter | Gutter | `string | number` | `0` | - |
| border | Whether to show border | `boolean` | `true` | - |
| center | Whether to center content | `boolean` | `true` | - |
| square | Whether to be square shape | `boolean` | `false` | - |
| clickable | Whether to show click feedback when clicked | `boolean` | `false` | - |
### GridItem Props
| Attribute | Description | Type | Default |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| text | Text | `string` | - |
| icon | Icon name or URL | `string` | - |
| url | Link URL | `string` | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` |
| text | Text | `string` | - | - |
| icon | Icon name or URL | `string` | - | - |
| url | Link URL | `string` | - | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` | - |
### GridItem Events

View File

@ -60,14 +60,14 @@ import 'vant/lib/icon/local.css';
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Icon name or URL | `string` | `''` |
| info | Info message | `string | number` | `''` |
| color | Icon color | `string` | `inherit` |
| size | Icon size | `string | number` | `inherit` |
| class-prefix | ClassName prefix | `string` | `van-icon` |
| tag | HTML Tag | `string` | `i` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Icon name or URL | `string` | `''` | - |
| info | Info message | `string | number` | `''` | - |
| color | Icon color | `string` | `inherit` | - |
| size | Icon size | `string | number` | `inherit` | - |
| class-prefix | ClassName prefix | `string` | `van-icon` | - |
| tag | HTML Tag | `string` | `i` | - |
### Events

View File

@ -67,7 +67,7 @@ import 'vant/lib/icon/local.css';
| name | 图标名称或图片链接 | `string` | - | - |
| info | 图标右上角文字提示 | `string | number` | - | - |
| color | 图标颜色 | `string` | `inherit` | - |
| size | 图标大小,如 `20px` `2em`,默认单位为`px` | `string | number` | `inherit` | 2.0.0 |
| size | 图标大小,如 `20px` `2em`,默认单位为`px` | `string | number` | `inherit` | - |
| class-prefix | 类名前缀 | `string` | `van-icon` | - |
| tag | HTML 标签 | `string` | `i` | - |

View File

@ -88,39 +88,39 @@ export default {
### Options
| Attribute | Description | Type | Default |
|------|------|------|------|
| images | Images URL list | `string[]` | `[]` |
| startPosition | Start position | `number` | `0` |
| showIndex | Whether to show index | `boolean` | `true` |
| showIndicators | Whether to show indicators | `boolean` | `false` |
| loop | Whether to enable loop | `boolean` | `true` |
| swipeDuration | Animation duration (ms) | `number` | `500` |
| onClose | Triggered when close | `Function` | - |
| onChange | Triggered when current image change | `Function` | - |
| closeOnPopstate | Whether to close when popstate | `boolean` | `false` |
| asyncClose | Whether to enable async close | `boolean` | `false` |
| className | Custom className | `any` | - |
| lazyLoad | Whether to enable thumb lazy loadshould register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` |
| maxZoom | Max zoom | `number` | `3` |
| minZoom | Min zoom | `number` | `1/3` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| images | Images URL list | `string[]` | `[]` | - |
| startPosition | Start position | `number` | `0` | - |
| showIndex | Whether to show index | `boolean` | `true` | - |
| showIndicators | Whether to show indicators | `boolean` | `false` | - |
| loop | Whether to enable loop | `boolean` | `true` | - |
| swipeDuration | Animation duration (ms) | `number` | `500` | - |
| onClose | Triggered when close | `Function` | - | - |
| onChange | Triggered when current image change | `Function` | - | 2.0.3 |
| closeOnPopstate | Whether to close when popstate | `boolean` | `false` | - |
| asyncClose | Whether to enable async close | `boolean` | `false` | - |
| className | Custom className | `any` | - | - |
| lazyLoad | Whether to enable thumb lazy loadshould register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` | - |
| maxZoom | Max zoom | `number` | `3` | - |
| minZoom | Min zoom | `number` | `1/3` | - |
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| images | Images URL list | `string[]` | `[]` |
| start-position | Start position | `number` | `0` |
| show-index | Whether to show index | `boolean` | `true` |
| show-indicators | Whether to show indicators | `boolean` | `false` |
| loop | Whether to enable loop | `boolean` | `true` |
| swipe-duration | Animation duration (ms) | `number` | `500` |
| async-close | Whether to enable async close | `boolean` | `false` |
| close-on-popstate | Whether to close when popstate | `boolean` | `false` |
| class-name | Custom className | `any` | - |
| lazy-load | Whether to enable thumb lazy loadshould register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` |
| max-zoom | Max zoom | `number` | `3` |
| min-zoom | Min zoom | `number` | `1/3` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| images | Images URL list | `string[]` | `[]` | - |
| start-position | Start position | `number` | `0` | - |
| show-index | Whether to show index | `boolean` | `true` | - |
| show-indicators | Whether to show indicators | `boolean` | `false` | - |
| loop | Whether to enable loop | `boolean` | `true` | - |
| swipe-duration | Animation duration (ms) | `number` | `500` | - |
| async-close | Whether to enable async close | `boolean` | `false` | - |
| close-on-popstate | Whether to close when popstate | `boolean` | `false` | - |
| class-name | Custom className | `any` | - | - |
| lazy-load | Whether to enable thumb lazy loadshould register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` | - |
| max-zoom | Max zoom | `number` | `3` | - |
| min-zoom | Min zoom | `number` | `1/3` | - |
### Events

View File

@ -111,7 +111,7 @@ export default {
| onClose | 关闭时的回调函数 | `Function` | - | - |
| onChange | 切换图片时的回调函数,回调参数为当前索引 | `Function` | - | 2.0.3 |
| asyncClose | 是否开启异步关闭 | `boolean` | `false` | - |
| closeOnPopstate | 是否在页面回退时自动关闭 | `boolean` | `false` | 2.0.0 |
| closeOnPopstate | 是否在页面回退时自动关闭 | `boolean` | `false` | - |
| className | 自定义类名 | `any` | - | - |
| lazyLoad | 是否开启图片懒加载,须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `boolean` | `false` | - |
| maxZoom | 手势缩放时,最大缩放比例 | `number` | `3` | - |
@ -130,7 +130,7 @@ export default {
| loop | 是否开启循环播放 | `boolean` | `true` | - |
| swipe-duration | 动画时长,单位为 ms | `number` | `500` | - |
| async-close | 是否开启异步关闭 | `boolean` | `false` | - |
| close-on-popstate | 是否在页面回退时自动关闭 | `boolean` | `false` |
| close-on-popstate | 是否在页面回退时自动关闭 | `boolean` | `false` | - |
| class-name | 自定义类名 | `any` | - | - |
| lazy-load | 是否开启图片懒加载,须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `boolean` | `false` | - |
| max-zoom | 手势缩放时,最大缩放比例 | `number` | `3` | - |

View File

@ -66,18 +66,18 @@ Vue.use(Lazyload);
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| src | Src | `string` | - | - |
| fit | Fit mode | `string` | `fill` | - |
| alt | Alt | `string` | - | - |
| width | Width | `string | number` | - | - |
| height | Height | `string | number` | - | - |
| radius | Border Radius | `string | number` | `0` | - |
| radius | Border Radius | `string | number` | `0` | 2.1.6 |
| round | Whether to be round | `boolean` | `false` | - |
| lazy-load | Whether to enable lazy loadshould register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` | - |
| show-error | Whether to show error placeholder | `boolean` | `true` |
| show-loading | Whether to show loading placeholder | `boolean` | `true` |
| show-error | Whether to show error placeholder | `boolean` | `true` | 2.0.9 |
| show-loading | Whether to show loading placeholder | `boolean` | `true` | 2.0.9 |
### fit optional value

View File

@ -61,19 +61,19 @@ export default {
### IndexBar Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| index-list | Index List | `string[] | number[]` | `A-Z` |
| z-index | z-index | `number` | `1` |
| sticky | Whether to enable anchor sticky top | `boolean` | `true` |
| sticky-offset-top | Anchor offset top when sticky | `number` | `0` |
| highlight-color | Index character highlight color | `string` | `#07c160` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| index-list | Index List | `string[] | number[]` | `A-Z` | - |
| z-index | z-index | `number` | `1` | - |
| sticky | Whether to enable anchor sticky top | `boolean` | `true` | - |
| sticky-offset-top | Anchor offset top when sticky | `number` | `0` | 2.0.7 |
| highlight-color | Index character highlight color | `string` | `#07c160` | - | - |
### IndexAnchor Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| index | Index | `string | number` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| index | Index | `string | number` | - | - |
### IndexBar Events

View File

@ -50,15 +50,15 @@ Use `v-lazy:background-image` to set background url, and declare the height of t
### Options
| Attribute | Description | Type | Default |
|------|------|------|------|
| loading | Src of the image while loading | `string` | - |
| error | Src of the image upon load fail | `string` | - |
| preload | Proportion of pre-loading height | `string` | - |
| attempt | Attempts count | `number` | `3` |
| listenEvents | Events that you want vue listen for | `string[]` | `scroll`... |
| adapter | Dynamically modify the attribute of element | `object` | - |
| filter | The image's listener filter | `object` | - |
| lazyComponent | Lazyload component | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| loading | Src of the image while loading | `string` | - | - |
| error | Src of the image upon load fail | `string` | - | - |
| preload | Proportion of pre-loading height | `string` | - | - |
| attempt | Attempts count | `number` | `3` | - |
| listenEvents | Events that you want vue listen for | `string[]` | `scroll`... | - |
| adapter | Dynamically modify the attribute of element | `object` | - | - |
| filter | The image's listener filter | `object` | - | - |
| lazyComponent | Lazyload component | `boolean` | `false` | - |
See more[ vue-lazyload ](https://github.com/hilongjw/vue-lazyload)

View File

@ -100,17 +100,17 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Whether to show loading infothe `load` event will not be triggered when loading | `boolean` | `false` |
| finished | Whether loading is finishedthe `load` event will not be triggered when finished | `boolean` | `false` |
| error | Whether loading is errorthe `load` event will be triggered only when error text clicked, the `sync` modifier is needed | `boolean` | `false` |
| offset | The load event will be triggered when the distance between the scrollbar and the bottom is less than offset | `number` | `300` |
| loading-text | Loading text | `string` | `Loading...` |
| finished-text | Finished text | `string` | - |
| error-text | Error loaded text | `string` | - |
| immediate-check | Whether to check loading position immediately after mounted | `boolean` | `true` |
| direction | Scroll directioncan be set to `up` | `string` | `down` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Whether to show loading infothe `load` event will not be triggered when loading | `boolean` | `false` | - |
| finished | Whether loading is finishedthe `load` event will not be triggered when finished | `boolean` | `false` | - |
| error | Whether loading is errorthe `load` event will be triggered only when error text clicked, the `sync` modifier is needed | `boolean` | `false` | - |
| offset | The load event will be triggered when the distance between the scrollbar and the bottom is less than offset | `number` | `300` | - |
| loading-text | Loading text | `string` | `Loading...` | - |
| finished-text | Finished text | `string` | - | - |
| error-text | Error loaded text | `string` | - | - |
| immediate-check | Whether to check loading position immediately after mounted | `boolean` | `true` | - |
| direction | Scroll directioncan be set to `up` | `string` | `down` | - |
### Events

View File

@ -41,13 +41,13 @@ Vue.use(Loading);
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| color | Loading color | `string` | `#c9c9c9` | |
| type | Can be set to `spinner` | `string` | `circular` |
| size | Icon size | `string | number` | `30px` |
| text-size | Text font size | `string | number` | `14px` |
| vertical | Whether to arrange icons and text content vertically | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| color | Loading color | `string` | `#c9c9c9` | - |
| type | Can be set to `spinner` | `string` | `circular` | - |
| size | Icon size | `string | number` | `30px` | - |
| text-size | Text font size | `string | number` | `14px` | - |
| vertical | Whether to arrange icons and text content vertically | `boolean` | `false` | - |
### Slots

View File

@ -46,8 +46,8 @@ Vue.use(Loading);
| color | 颜色 | `string` | `#c9c9c9` | - |
| type | 类型,可选值为 `spinner` | `string` | `circular` | - |
| size | 加载图标大小,默认单位为`px` | `string | number` | `30px` | - |
| text-size | 文字大小,默认单位为`px` | `string | number` | `14px` | 2.0.0 |
| vertical | 是否垂直排列图标和文字内容 | `boolean` | `false` | 2.0.0 |
| text-size | 文字大小,默认单位为`px` | `string | number` | `14px` | - |
| vertical | 是否垂直排列图标和文字内容 | `boolean` | `false` | - |
### Slots

View File

@ -46,5 +46,4 @@ Current supported languages:
| Turkish | tr-TR |
| Spanish (Spain) | es-ES |
View all language configs [Here](https://github.com/youzan/vant/tree/dev/src/locale/lang).

View File

@ -49,15 +49,15 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Title | `string` | `''` |
| left-text | Left Text | `string` | `''` |
| right-text | Right Text | `string` | `''` |
| left-arrow | Whether to show left arrow | `boolean` | `false` |
| fixed | Whether to fixed top | `boolean` | `false` |
| border | Whether to show bottom border | `boolean` | `true` |
| z-index | Z-index | `number` | `1` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| title | Title | `string` | `''` | - |
| left-text | Left Text | `string` | `''` | - |
| right-text | Right Text | `string` | `''` | - |
| left-arrow | Whether to show left arrow | `boolean` | `false` | - |
| fixed | Whether to fixed top | `boolean` | `false` | - |
| border | Whether to show bottom border | `boolean` | `true` | - |
| z-index | Z-index | `number` | `1` | - |
### Slots

View File

@ -64,17 +64,17 @@ Vue.use(NoticeBar);
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| mode | Mode, can be set to `closeable` `link` | `string` | `''` |
| text | Notice text content | `string` | `''` | - |
| delay | Animation delay (s) | `number` | `1` |
| speed | Scroll speed (px/s) | `number` | `50` |
| scrollable | Whether to scroll content | `boolean` | `true` |
| wrapable | Whether to enable text wrap | `boolean` | `false` | - |
| left-icon | Left Icon | `string` | - |
| color | Text color | `string` | `#f60` |
| background | Background color | `string` | `#fff7cc` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| mode | Mode, can be set to `closeable` `link` | `string` | `''` | - |
| text | Notice text content | `string` | `''` | - | - |
| delay | Animation delay (s) | `number` | `1` | - |
| speed | Scroll speed (px/s) | `number` | `50` | - |
| scrollable | Whether to scroll content | `boolean` | `true` | - |
| wrapable | Whether to enable text wrap | `boolean` | `false` | - | - |
| left-icon | Left Icon | `string` | - | - |
| color | Text color | `string` | `#f60` | - |
| background | Background color | `string` | `#fff7cc` | - |
### Events

View File

@ -64,16 +64,16 @@ export default {
| Notify.setDefaultOptions | `options` | `void` | Set default options of all notifies |
| Notify.resetDefaultOptions | - | `void` | Reset default options of all notifies |
### Props
### Options
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Can be set to `primary` `info` `warning` | `string` | `danger` |
| message | Message | `string` | - |
| duration | Duration(ms), won't disappear if value is 0 | `number` | `3000` |
| color | Message color | `string` | `#fff` | |
| background | Background color | `string` | `#f44` |
| className | Custom className | `any` | - |
| onClick | Callback function after click | `Function` | - |
| onOpened | Callback function after opened | `Function` | - |
| onClose | Callback function after close | `Function` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| type | Can be set to `primary` `info` `warning` | `string` | `danger` | - |
| message | Message | `string` | - | - |
| duration | Duration(ms), won't disappear if value is 0 | `number` | `3000` | - |
| color | Message color | `string` | `#fff` | | - |
| background | Background color | `string` | `#f44` | - |
| className | Custom className | `any` | - | - |
| onClick | Callback function after click | `Function` | - | - |
| onOpened | Callback function after opened | `Function` | - | - |
| onClose | Callback function after close | `Function` | - | - |

View File

@ -85,6 +85,6 @@ export default {
| color | 字体颜色 | `string` | `#fff` | - |
| background | 背景颜色 | `string` | `#f44` | - |
| className | 自定义类名 | `any` | - | - |
| onClick | 点击时的回调函数 | `Function` | - | 2.0.0 |
| onOpened | 完全展示后的回调函数 | `Function` | - | 2.0.0 |
| onClose | 关闭时的回调函数 | `Function` | - | 2.0.0 |
| onClick | 点击时的回调函数 | `Function` | - | - |
| onOpened | 完全展示后的回调函数 | `Function` | - | - |
| onClose | 关闭时的回调函数 | `Function` | - | - |

View File

@ -94,21 +94,21 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current value | `string` | - |
| show | Whether to show keyboard | `boolean` | - |
| theme | Keyboard themecan be set to `default` `custom` | `string` | `default` |
| title | Keyboard title | `string` | - |
| maxlength | Value maxlength | `number | string` | - |
| transition | Whether to show transition animation | `boolean` | `true` |
| z-index | Keyboard z-index | `number` | `100` |
| extra-key | Content of bottom left key | `string` | `''` |
| close-button-text | Close button text | `string` | `-` |
| delete-button-text | Delete button text | `string` | `delete` |
| show-delete-key | Whether to show delete button | `boolean` | `true` |
| 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` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Current value | `string` | - | 2.0.2 |
| show | Whether to show keyboard | `boolean` | - | - |
| theme | Keyboard themecan be set to `default` `custom` | `string` | `default` | - |
| title | Keyboard title | `string` | - | - |
| maxlength | Value maxlength | `number | string` | - | 2.0.2 |
| transition | Whether to show transition animation | `boolean` | `true` | - |
| z-index | Keyboard z-index | `number` | `100` | - |
| extra-key | Content of bottom left key | `string` | `''` | - |
| close-button-text | Close button text | `string` | `-` | - |
| delete-button-text | Delete button text | `string` | `delete` | - |
| show-delete-key | Whether to show delete button | `boolean` | `true` | - |
| 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` | - |
### Events

View File

@ -40,12 +40,12 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| show | Whether to show overlay | `boolean` | `false` |
| z-index | z-index | `number | string` | `1` |
| duration | Animation duration | `number | string` | `0.3` |
| class-name | ClassName | `string` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| show | Whether to show overlay | `boolean` | `false` | - |
| z-index | z-index | `number | string` | `1` | - |
| duration | Animation duration | `number | string` | `0.3` | - |
| class-name | ClassName | `string` | - | - |
### Events

View File

@ -56,17 +56,17 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current page number | `number` | - |
| mode | Mode, can be set to `simple` `multi` | `string` | `multi` |
| total-items | Total items | `number` | `0` |
| items-per-page | Item number per page | `number` | `10` |
| page-count | The total number of pages, if not set, will be calculated based on `total-items` and `items-per-page` | `number` | `-` |
| prev-text | Previous text | `string` | `Previous` |
| next-text | Next text | `string` | `Next` |
| show-page-size | Count of page size to show | `number` | `5` |
| force-ellipses | Whether to show ellipses | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Current page number | `number` | - | - |
| mode | Mode, can be set to `simple` `multi` | `string` | `multi` | - |
| total-items | Total items | `number` | `0` | - |
| items-per-page | Item number per page | `number` | `10` | - |
| page-count | The total number of pages, if not set, will be calculated based on `total-items` and `items-per-page` | `number` | `-` | - |
| prev-text | Previous text | `string` | `Previous` | - |
| next-text | Next text | `string` | `Next` | - |
| show-page-size | Count of page size to show | `number` | `5` | - |
| force-ellipses | Whether to show ellipses | `boolean` | `false` | - |
### Events

View File

@ -35,12 +35,12 @@ Vue.use(Panel);
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| icon | Left Icon | `string` | - |
| title | Title | `string` | - |
| desc | Description | `string` | - |
| status | Status | `string` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| icon | Left Icon | `string` | - | - |
| title | Title | `string` | - | - |
| desc | Description | `string` | - | - |
| status | Status | `string` | - | - |
### Slots

View File

@ -79,14 +79,14 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| value | Password value | `string` | `''` |
| length | Maxlength of password | `number` | `6` |
| mask | Whether to mask value | `boolean` | `true` |
| info | Bottom info | `string` | - |
| error-info | Bottom error info | `string` | - |
| gutter | Gutter of input | `number | string` | `0` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| value | Password value | `string` | `''` | - |
| length | Maxlength of password | `number` | `6` | - |
| mask | Whether to mask value | `boolean` | `true` | - |
| info | Bottom info | `string` | - | - |
| error-info | Bottom error info | `string` | - | - |
| gutter | Gutter of input | `number | string` | `0` | - |
### Events

View File

@ -84,7 +84,7 @@ export default {
| mask | 是否隐藏密码内容 | `boolean` | `true` | - |
| info | 输入框下方文字提示 | `string` | - | - |
| error-info | 输入框下方错误提示 | `string` | - | - |
| gutter | 输入框格子之间的间距,如 `20px` `2em`,默认单位为`px` | `number | string` | `0` | 2.0.0 |
| gutter | 输入框格子之间的间距,如 `20px` `2em`,默认单位为`px` | `number | string` | `0` | - |
### Events

View File

@ -184,19 +184,19 @@ When Picker columns data is acquired asynchronously, use `loading` prop to show
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| columns | Columns data | `Column[]` | `[]` |
| show-toolbar | Whether to show toolbar | `boolean` | `false` |
| toolbar-position | Toolbar position, cat be set to `bottom` | `string` | `top` |
| title | Toolbar title | `string` | `''` |
| loading | Whether to show loading prompt | `boolean` | `false` |
| value-key | Key of option text | `string` | `text` |
| item-height | Option height | `number` | `44` |
| confirm-button-text | Text of confirm button | `string` | `Confirm` |
| cancel-button-text | Text of cancel button | `string` | `Cancel` |
| visible-item-count | Count of visible columns | `number` | `5` |
| default-index | Default value index of single column picker | `number` | `0` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| columns | Columns data | `Column[]` | `[]` | - |
| show-toolbar | Whether to show toolbar | `boolean` | `false` | - |
| toolbar-position | Toolbar position, cat be set to `bottom` | `string` | `top` | - |
| title | Toolbar title | `string` | `''` | - |
| loading | Whether to show loading prompt | `boolean` | `false` | - |
| value-key | Key of option text | `string` | `text` | - |
| item-height | Option height | `number` | `44` | - |
| confirm-button-text | Text of confirm button | `string` | `Confirm` | - |
| cancel-button-text | Text of cancel button | `string` | `Cancel` | - |
| visible-item-count | Count of visible columns | `number` | `5` | - |
| default-index | Default value index of single column picker | `number` | `0` | - |
### Events

View File

@ -196,7 +196,7 @@ export default {
|------|------|------|------|------|
| columns | 对象数组,配置每一列显示的数据 | `Column[]` | `[]` | - |
| show-toolbar | 是否显示顶部栏 | `boolean` | `false` | - |
| toolbar-position | 顶部栏位置,可选值为`bottom` | `string` | `top` | 2.0.0 |
| toolbar-position | 顶部栏位置,可选值为`bottom` | `string` | `top` | - |
| title | 顶部栏标题 | `string` | `''` | - |
| loading | 是否显示加载状态 | `boolean` | `false` | - |
| value-key | 选项对象中,文字对应的 key | `string` | `text` | - |

View File

@ -98,20 +98,20 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Whether to show popup | `boolean` | `false` |
| overlay | Whether to show overlay | `boolean` | `true` |
| position | Can be set to `top` `bottom` `right` `left` | `string` | `center` |
| overlay-class | Custom overlay class | `string` | - |
| overlay-style | Custom overlay style | `object` | - |
| duration | Transition duration, unit second | `number` | `0.3` |
| round | Whether to show round corner | `boolean` | `false` |
| lock-scroll | Whether to lock background scroll | `boolean` | `true` |
| lazy-render | Whether to lazy render util appeared | `boolean` | `true` |
| close-on-click-overlay | Whether to close when click overlay | `boolean` | `true` |
| transition | Transition | `string` | `popup-slide` |
| get-container | Return the mount node for Popup | `string | () => HTMLElement` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Whether to show popup | `boolean` | `false` | - |
| overlay | Whether to show overlay | `boolean` | `true` | - |
| position | Can be set to `top` `bottom` `right` `left` | `string` | `center` | - |
| overlay-class | Custom overlay class | `string` | - | - |
| overlay-style | Custom overlay style | `object` | - | - |
| duration | Transition duration, unit second | `number` | `0.3` | - |
| round | Whether to show round corner | `boolean` | `false` | 2.0.7 |
| lock-scroll | Whether to lock background scroll | `boolean` | `true` | - |
| lazy-render | Whether to lazy render util appeared | `boolean` | `true` | - |
| close-on-click-overlay | Whether to close when click overlay | `boolean` | `true` | - |
| transition | Transition | `string` | `popup-slide` | - |
| get-container | Return the mount node for Popup | `string | () => HTMLElement` | - | - |
### Events

View File

@ -114,7 +114,7 @@ export default {
| position | 弹出位置,可选值为 `top` `bottom` `right` `left` | `string` | `center` | - |
| overlay-class | 自定义遮罩层类名 | `string` | - | - |
| overlay-style | 自定义遮罩层样式 | `object` | - | - |
| duration | 动画时长,单位秒 | `number` | `0.3` | 2.0.0 |
| duration | 动画时长,单位秒 | `number` | `0.3` | - |
| round | 是否显示圆角 | `boolean` | `false` | 2.0.7 |
| lock-scroll | 是否锁定背景滚动 | `boolean` | `true` | - |
| lazy-render | 是否在显示弹层时才渲染节点 | `boolean` | `true` | - |

View File

@ -56,12 +56,12 @@ Use `pivot-text` to custom textuse `color` to custom bar color
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| inactive | Whether to be gray | `boolean` | `false` |
| percentage | Percentage | `number` | `0` |
| show-pivot | Whether to show text | `boolean` | `true` |
| color | Color | `string` | `#1989fa` |
| pivot-text | Text | `string` | percentage |
| pivot-color | Text background color | `string` | inherit progress color |
| text-color | Text color | `string` | `#fff` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| inactive | Whether to be gray | `boolean` | `false` | - |
| percentage | Percentage | `number` | `0` | - |
| show-pivot | Whether to show text | `boolean` | `true` | - |
| color | Color | `string` | `#1989fa` | - |
| pivot-text | Text | `string` | percentage | - |
| pivot-color | Text background color | `string` | inherit progress color | - |
| text-color | Text color | `string` | `#fff` | - |

View File

@ -46,17 +46,17 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Loading status | `boolean` | - |
| pulling-text | Text to show when pulling | `string` | `Pull to refresh...` |
| loosing-text | Text to show when loosing | `string` | `Loose to refresh...` |
| loading-text | Text to show when loading | `string` | `Loading...` |
| success-text | Text to show when loading success | `string` | - |
| success-duration | Success text display duration(ms) | `number` | `500` |
| animation-duration | Animation duration | `number` | `300` |
| head-height | Height of head | `number` | `50` |
| disabled | Whether to disable pull refresh | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Loading status | `boolean` | - | - |
| pulling-text | Text to show when pulling | `string` | `Pull to refresh...` | - |
| loosing-text | Text to show when loosing | `string` | `Loose to refresh...` | - |
| loading-text | Text to show when loading | `string` | `Loading...` | - |
| success-text | Text to show when loading success | `string` | - | - |
| success-duration | Success text display duration(ms) | `number` | `500` | - |
| animation-duration | Animation duration | `number` | `300` | - |
| head-height | Height of head | `number` | `50` | - |
| disabled | Whether to disable pull refresh | `boolean` | `false` | - |
### Events

View File

@ -107,22 +107,22 @@ export default {
### Radio Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Radio name | `any` | - |
| shape | Can be set to `square` | `string` | `round` |
| disabled | Whether to disable radio | `boolean` | `false` |
| icon-size | Icon size | `string | number` | `20px` |
| label-disabled | Whether to disable label click | `boolean` | `false` |
| label-position | Can be set to `left` | `string` | `right` |
| checked-color | Checked color | `string` | `#1989fa` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Radio name | `any` | - | - |
| shape | Can be set to `square` | `string` | `round` | - |
| disabled | Whether to disable radio | `boolean` | `false` | - |
| icon-size | Icon size | `string | number` | `20px` | - |
| label-disabled | Whether to disable label click | `boolean` | `false` | - |
| label-position | Can be set to `left` | `string` | `right` | - |
| checked-color | Checked color | `string` | `#1989fa` | - | - |
### RadioGroup Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Name of checked radio | `any` | - |
| disabled | Diable all radios | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Name of checked radio | `any` | - | - |
| disabled | Diable all radios | `boolean` | `false` | - |
### Radio Events

View File

@ -118,7 +118,7 @@ export default {
| name | 标识符 | `any` | - | - |
| shape | 形状,可选值为 `square` | `string` | `round` | - |
| disabled | 是否为禁用状态 | `boolean` | `false` | - |
| icon-size | 图标大小,默认单位为`px` | `string | number` | `20px` | 2.0.0 |
| icon-size | 图标大小,默认单位为`px` | `string | number` | `20px` | - |
| label-disabled | 是否禁用文本内容点击 | `boolean` | `false` | - |
| label-position | 文本位置,可选值为 `left` | `string` | `right` | - |
| checked-color | 选中状态颜色 | `string` | `#1989fa` | - |

View File

@ -92,20 +92,20 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current rate | `number` | - |
| count | Count | `number` | `5` |
| size | Icon size| `string | number` | `20px` |
| gutter | Icon gutter | `string | number` | `4px` |
| color | Selected color | `string` | `#ffd21e` |
| void-color | Void color | `string` | `#c7c7c7` |
| icon | Selected icon | `string` | `star` |
| void-icon | Void icon | `string` | `star-o` |
| allow-half | Whether to allow half star | `boolean` | `false` |
| readonly | Whether to be readonly | `boolean` | `false` |
| disabled | Whether to disable rate | `boolean` | `false` |
| disabled-color | Disabled color | `string` | `#bdbdbd` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Current rate | `number` | - | - |
| count | Count | `number` | `5` | - |
| size | Icon size| `string | number` | `20px` | - |
| gutter | Icon gutter | `string | number` | `4px` | - |
| color | Selected color | `string` | `#ffd21e` | - |
| void-color | Void color | `string` | `#c7c7c7` | - |
| icon | Selected icon | `string` | `star` | - |
| void-icon | Void icon | `string` | `star-o` | - |
| allow-half | Whether to allow half star | `boolean` | `false` | - |
| readonly | Whether to be readonly | `boolean` | `false` | - |
| disabled | Whether to disable rate | `boolean` | `false` | - |
| disabled-color | Disabled color | `string` | `#bdbdbd` | - |
### Events

View File

@ -97,7 +97,7 @@ export default {
| v-model | 当前分值 | `number` | - | - |
| count | 图标总数 | `number` | `5` | - |
| size | 图标大小,默认单位为`px` | `string | number` | `20px` | - |
| gutter | 图标间距,默认单位为`px` | `string | number` | `4px` | 2.0.0 |
| gutter | 图标间距,默认单位为`px` | `string | number` | `4px` | - |
| color | 选中时的颜色 | `string` | `#ffd21e` | - |
| void-color | 未选中时的颜色 | `string` | `#c7c7c7` | - |
| icon | 选中时的图标名称或图片链接,可选值见 Icon 组件 | `string` | `star` | - |

View File

@ -66,19 +66,19 @@ Use `action` slot to custom right button, `cancel` event will no longer be trigg
Search support all native properties of input tagsuch as `maxlength``placeholder``autofocus`
| Attribute | Description | Type | Default |
|------|------|------|------|
| label | Search label | `string` | - |
| shape | Can be set to `round` | `string` | `square` |
| background | Background color | `string` | `#f2f2f2` |
| clearable | Whether to be clearable | `boolean` | `true` |
| show-action | Whether to show right button | `boolean` | `false` |
| disabled | Whether to disable field | `boolean` | `false` |
| readonly | Whether to be readonly | `boolean` | `false` |
| error | Whether to show error info | `boolean` | `false` |
| input-align | Input text align, can be set to `center` `right` | `string` | `left` |
| left-icon | Left icon name | `string` | `search` |
| right-icon | Right icon name | `string` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| label | Search label | `string` | - | - |
| shape | Can be set to `round` | `string` | `square` | - |
| background | Background color | `string` | `#f2f2f2` | - |
| clearable | Whether to be clearable | `boolean` | `true` | - |
| show-action | Whether to show right button | `boolean` | `false` | - |
| disabled | Whether to disable field | `boolean` | `false` | - |
| readonly | Whether to be readonly | `boolean` | `false` | - |
| error | Whether to show error info | `boolean` | `false` | - |
| input-align | Input text align, can be set to `center` `right` | `string` | `left` | - |
| left-icon | Left icon name | `string` | `search` | - |
| right-icon | Right icon name | `string` | - | - |
### Events

View File

@ -64,14 +64,14 @@ Search 默认支持 Input 标签所有的原生属性,比如 `maxlength`、`pl
| label | 搜索框左侧文本 | `string` | - | - |
| shape | 形状,可选值为 `round` | `string` | `square` | - |
| background | 搜索框背景色 | `string` | `#f2f2f2` | - |
| clearable | 是否启用清除控件 | `boolean` | `true` | 2.0.0 |
| clearable | 是否启用清除控件 | `boolean` | `true` | - |
| show-action | 是否在搜索框右侧显示取消按钮 | `boolean` | `false` | - |
| disabled | 是否禁用输入框 | `boolean` | `false` | - |
| readonly | 是否将输入框设为只读 | `boolean` | `false` | - |
| error | 是否将输入内容标红 | `boolean` | `false` | - |
| input-align | 输入框内容对齐方式,可选值为 `center` `right` | `string` | `left` | - |
| left-icon | 输入框左侧图标名称或图片链接,可选值见 Icon 组件 | `string` | `search` | 2.0.0 |
| right-icon | 输入框右侧图标名称或图片链接,可选值见 Icon 组件 | `string` | - | 2.0.0 |
| left-icon | 输入框左侧图标名称或图片链接,可选值见 Icon 组件 | `string` | `search` | - |
| right-icon | 输入框右侧图标名称或图片链接,可选值见 Icon 组件 | `string` | - | - |
### Events

View File

@ -46,9 +46,9 @@ export default {
### Sidebar Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Index of chosen item | `string | number` | `0` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Index of chosen item | `string | number` | `0` | - |
### Sidebar Events
@ -58,11 +58,13 @@ export default {
### SidebarItem Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| title | Content | `string` | `''` |
| info | Info Message | `string | number` | `''` |
| url | Link | `string` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| title | Content | `string` | `''` | - |
| info | Info Message | `string | number` | `''` | - |
| url | Link | `string` | - | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - | 2.0.4 |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` | 2.0.4 |
### SidebarItem Events

View File

@ -53,14 +53,14 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| row | Row count | `number` | `0` |
| row-width | Row width, can be array | `number | string | number[] | string []` | `100%` |
| title | Whether to show title placeholder | `boolean` | `false` |
| title-width | Title width | `number | string` | `40%` |
| avatar | Whether to show avatar placeholder | `boolean` | `false` |
| avatar-size | Size of avatar placeholder | `number | string` | `32px` |
| avatar-shape | Shape of avatar placeholdercan be set to `square` | `string` | `round` |
| loading | Whether to show skeletonpass `false` to show child component | `boolean` | `true` |
| animate | Whether to enable animation | `boolean` | `true` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| row | Row count | `number` | `0` | - |
| row-width | Row width, can be array | `number | string | number[] | string []` | `100%` | - |
| title | Whether to show title placeholder | `boolean` | `false` | - |
| title-width | Title width | `number | string` | `40%` | - |
| avatar | Whether to show avatar placeholder | `boolean` | `false` | - |
| avatar-size | Size of avatar placeholder | `number | string` | `32px` | - |
| avatar-shape | Shape of avatar placeholdercan be set to `square` | `string` | `round` | - |
| loading | Whether to show skeletonpass `false` to show child component | `boolean` | `true` | - |
| animate | Whether to enable animation | `boolean` | `true` | - |

View File

@ -116,29 +116,29 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Whether to show sku | `boolean` | `false` |
| sku | Sku data | `object` | - |
| goods | Goods info | `object` | - |
| goods-id | Goods id | `string | `number` | - |
| price-tag | Tag behind the price | `string` | - |
| hide-stock | Whether to hide stock | `boolean` | `false` |
| hide-quota-text | Whether to hide quota text | `boolean` | `false` |
| hide-selected-text | Whether to hide selected text | `boolean` | `false` |
| show-add-cart-btn | Whether to show cart button | `boolean` | `true` |
| buy-text | Buy button text | `string` | - | - |
| add-cart-text | Add cart button text | `string` | - | - |
| quota | Quota (0 as no limit) | `number` | `0` |
| quota-used | Used quota | `number` | `0` |
| reset-stepper-on-hide | Whether to reset stepper when hide | `boolean` | `false` |
| reset-selected-sku-on-hide | Whether to reset selected sku when hide | `boolean` | `false` |
| disable-stepper-input | Whether to disable stepper input | `boolean` | `false` |
| close-on-click-overlay | Whether to close sku popup when click overlay | `boolean` | `false` |
| stepper-title | Quantity title | `string` | `Quantity` |
| custom-stepper-config | Custom stepper related config | `object` | `{}` |
| message-config | Message related config | `object` | `{}` |
| get-container | Return the mount node for sku | `string | () => HTMLElement` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Whether to show sku | `boolean` | `false` | - |
| sku | Sku data | `object` | - | - |
| goods | Goods info | `object` | - | - |
| goods-id | Goods id | `string | `number` | - | - |
| price-tag | Tag behind the price | `string` | - | - |
| hide-stock | Whether to hide stock | `boolean` | `false` | - |
| hide-quota-text | Whether to hide quota text | `boolean` | `false` | - |
| hide-selected-text | Whether to hide selected text | `boolean` | `false` | - |
| show-add-cart-btn | Whether to show cart button | `boolean` | `true` | - |
| buy-text | Buy button text | `string` | - | - | - |
| add-cart-text | Add cart button text | `string` | - | - | - |
| quota | Quota (0 as no limit) | `number` | `0` | - |
| quota-used | Used quota | `number` | `0` | - |
| reset-stepper-on-hide | Whether to reset stepper when hide | `boolean` | `false` | - |
| reset-selected-sku-on-hide | Whether to reset selected sku when hide | `boolean` | `false` | - |
| disable-stepper-input | Whether to disable stepper input | `boolean` | `false` | - |
| close-on-click-overlay | Whether to close sku popup when click overlay | `boolean` | `false` | - |
| stepper-title | Quantity title | `string` | `Quantity` | - |
| custom-stepper-config | Custom stepper related config | `object` | `{}` | - |
| message-config | Message related config | `object` | `{}` | - |
| get-container | Return the mount node for sku | `string | () => HTMLElement` | - | - |
### Events

View File

@ -89,17 +89,17 @@ export default {
### Props
| Attribute | Description | Type | Default |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| value | Current value | `number` | `0` |
| disabled | Whether to disable slider | `boolean` | `false` |
| max | Max value | `number` | `100` |
| min | Min value | `number` | `0` |
| step | Step size | `number` | `1` |
| bar-height | Height of bar | `number | string` | `2px` |
| active-color | Active color of bar | `string` | `#1989fa` |
| inactive-color | Inactive color of bar | `string` | `#e5e5e5` |
| vertical | Whether to display vertical | `boolean` | `false` |
| value | Current value | `number` | `0` | - |
| disabled | Whether to disable slider | `boolean` | `false` | - |
| max | Max value | `number` | `100` | - |
| min | Min value | `number` | `0` | - |
| step | Step size | `number` | `1` | - |
| bar-height | Height of bar | `number | string` | `2px` | - |
| active-color | Active color of bar | `string` | `#1989fa` | - |
| inactive-color | Inactive color of bar | `string` | `#e5e5e5` | - |
| vertical | Whether to display vertical | `boolean` | `false` | - |
### Events

View File

@ -96,20 +96,20 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current value | `string | number` | Min value |
| min | Min value | `string | number` | `1` |
| max | Max value | `string | number` | - |
| step | Value change step | `string | number` | `1` |
| integer | Whether to allow only integers | `boolean` | `false` |
| disabled | Disable value change | `boolean` | `false` |
| disable-input | Disable input | `boolean` | `false` |
| async-change | Whether to enable async change | `boolean` | `false` | - |
| input-width | Input width | `string | number` | `32px` |
| button-size | Button size | `string | number` | `28px` |
| show-plus | Whether to show plus button | `boolean` | `true` |
| show-minus | Whether to show minus button | `boolean` | `true` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Current value | `string | number` | Min value | - |
| min | Min value | `string | number` | `1` | - |
| max | Max value | `string | number` | - | - |
| step | Value change step | `string | number` | `1` | - |
| integer | Whether to allow only integers | `boolean` | `false` | - |
| disabled | Disable value change | `boolean` | `false` | - |
| disable-input | Disable input | `boolean` | `false` | - |
| async-change | Whether to enable async change | `boolean` | `false` | - | - |
| input-width | Input width | `string | number` | `32px` | - |
| button-size | Button size | `string | number` | `28px` | 2.0.5 |
| show-plus | Whether to show plus button | `boolean` | `true` | 2.1.2 |
| show-minus | Whether to show minus button | `boolean` | `true` | 2.1.2 |
### Events

View File

@ -70,14 +70,14 @@ export default {
### Steps Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| active | Active step | `number` | 0 |
| description | Description | `string` | - |
| direction | Can be set to `vertical` | `string` | `horizontal` |
| active-color | Active step color | `string` | `#07c160` |
| active-icon | Active icon name | `string` | `checked` |
| inactive-icon | Active icon name | `string` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| active | Active step | `number` | 0 | - |
| description | Description | `string` | - | - |
| direction | Can be set to `vertical` | `string` | `horizontal` | - |
| active-color | Active step color | `string` | `#07c160` | - |
| active-icon | Active icon name | `string` | `checked` | - |
| inactive-icon | Active icon name | `string` | - | - |
### Step Slots

View File

@ -80,7 +80,7 @@ export default {
| direction | 显示方向,可选值为 `vertical` | `string` | `horizontal` | - |
| active-color | 激活状态颜色 | `string` | `#07c160` | - |
| active-icon | 激活状态底部图标,可选值见 Icon 组件 | `string` | `checked` | - |
| inactive-icon | 未激活状态底部图标,可选值见 Icon 组件 | `string` | - | 2.0.0 |
| inactive-icon | 未激活状态底部图标,可选值见 Icon 组件 | `string` | - | - |
### Step Slots

View File

@ -54,8 +54,8 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| offset-top | Offset top | `number` | `0` | - |
| z-index | z-index when sticky | `number` | `99` | - |
| container | Container DOM | `HTMLElement` | - | - |

View File

@ -70,20 +70,20 @@ Use slot to add custom contents.
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| price | Price | `number` | - |
| label | Price left label | `string` | `Total` |
| suffix-label | Price right label | `string` | - |
| button-text | Button text | `string` | - |
| button-type | Button type | `string` | `danger` |
| tip | Tip | `string` | - |
| tip-icon | Icon | `string` | - |
| disabled | Whether to disable button | `boolean` | `false` |
| loading | Whether to show loading icon | `boolean` | `false` |
| currency | Currency symbol | `string` | `¥` |
| 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` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| price | Price | `number` | - | - |
| label | Price left label | `string` | `Total` | - |
| suffix-label | Price right label | `string` | - | - |
| button-text | Button text | `string` | - | - |
| button-type | Button type | `string` | `danger` | - |
| tip | Tip | `string` | - | - |
| tip-icon | Icon | `string` | - | - |
| disabled | Whether to disable button | `boolean` | `false` | - |
| loading | Whether to show loading icon | `boolean` | `false` | - |
| currency | Currency symbol | `string` | `¥` | - |
| 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` | - |
### Events

View File

@ -74,7 +74,7 @@ Vue.use(SubmitBar);
|------|------|------|------|------|
| price | 价格(单位分) | `number` | - | - |
| label | 价格左侧文案 | `string` | `合计:` | - |
| suffix-label | 价格右侧文案 | `string` | - | 2.0.0 |
| suffix-label | 价格右侧文案 | `string` | - | - |
| button-text | 按钮文字 | `string` | - | - |
| button-type | 按钮类型 | `string` | `danger` | - |
| tip | 提示文案 | `string` | - | - |

View File

@ -71,14 +71,14 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Identifier of SwipeCell | `string | number` | - |
| on-close | Callback function before close | `Function` | - |
| disabled | Whether to disabled swipe | `boolean` | `false` |
| left-width | Width of the left swipe area | `number` | `auto` |
| right-width | Width of the right swipe area | `number` | `auto` |
| stop-propagation | Whether to stop touchmove event propagation | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Identifier of SwipeCell | `string | number` | - | 2.0.4 |
| on-close | Callback function before close | `Function` | - | - |
| disabled | Whether to disabled swipe | `boolean` | `false` | - |
| left-width | Width of the left swipe area | `number` | `auto` | - |
| right-width | Width of the right swipe area | `number` | `auto` | - |
| stop-propagation | Whether to stop touchmove event propagation | `boolean` | `false` | 2.1.0 |
### Slots

View File

@ -126,18 +126,18 @@ export default {
### Swipe Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| autoplay | Autoplay interval (ms) | `number` | - |
| duration | Animation duration (ms) | `number` | `500` |
| loop | Whether to enable loop | `boolean` | `true` |
| vertical | Vertical Scrolling | `boolean` | `false` |
| touchable | Whether touchable | `boolean` | `true` |
| show-indicators | Whether to show indicators | `boolean` | `true` |
| indicator-color | Indicator color | `string` | `#1989fa` |
| initial-swipe | Index of initial swipe, start from 0 | `number` | `0` |
| width | Set Swiper Item Width | `number` | `0` |
| height | Set Swiper Item Height | `number` | `0` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| autoplay | Autoplay interval (ms) | `number` | - | - |
| duration | Animation duration (ms) | `number` | `500` | - |
| loop | Whether to enable loop | `boolean` | `true` | - |
| vertical | Vertical Scrolling | `boolean` | `false` | - |
| touchable | Whether touchable | `boolean` | `true` | - |
| show-indicators | Whether to show indicators | `boolean` | `true` | - |
| indicator-color | Indicator color | `string` | `#1989fa` | - |
| initial-swipe | Index of initial swipe, start from 0 | `number` | `0` | - |
| width | Set Swiper Item Width | `number` | `0` | - |
| height | Set Swiper Item Height | `number` | `0` | - |
### Swipe Events

View File

@ -57,19 +57,19 @@ use `loading` property to keep component in loading state
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | on-off state of the switch | `any` | `false` |
| title | the left side title | `string` | `''` |
| border | whether to show cell border | `boolean` | `true` |
| cell-size | Cell sizecan be set to `large` | `string` | - |
| loading | whether switch is loading | `boolean` | `false` |
| disabled | whether to disable switch | `boolean` | `false` |
| size | Size of switch | `string` | `24px` |
| active-color | Background of switch color when active | `string` | `#1989fa` |
| inactive-color | Background of switch color when inactive | `string` | `#fff` |
| active-value | Value when active | `any` | `true` |
| inactive-value | Value when inactive | `any` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | on-off state of the switch | `any` | `false` | - |
| title | the left side title | `string` | `''` | - |
| border | whether to show cell border | `boolean` | `true` | - |
| cell-size | Cell sizecan be set to `large` | `string` | - | - |
| loading | whether switch is loading | `boolean` | `false` | - |
| disabled | whether to disable switch | `boolean` | `false` | - |
| size | Size of switch | `string` | `24px` | - |
| active-color | Background of switch color when active | `string` | `#1989fa` | - |
| inactive-color | Background of switch color when inactive | `string` | `#fff` | - |
| active-value | Value when active | `any` | `true` | - |
| inactive-value | Value when inactive | `any` | `false` | - |
### Events

View File

@ -61,8 +61,8 @@ export default {
|------|------|------|------|------|
| v-model | 开关状态 | `any` | `false` | - |
| title | 左侧标题 | `string` | `''` | - |
| border | 是否展示单元格内边框 | `boolean` | `true` | 2.0.0 |
| cell-size | 单元格大小,可选值为 `large` | `string` | 2.0.0 |
| border | 是否展示单元格内边框 | `boolean` | `true` | - |
| cell-size | 单元格大小,可选值为 `large` | `string` | - |
| loading | 是否为加载状态 | `boolean` | `false` | - |
| disabled | 是否为禁用状态 | `boolean` | `false` | - |
| size | 开关尺寸 | `string` | `24px` | - |

View File

@ -98,16 +98,16 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Check status of Switch | `any` | `false` |
| loading | Whether to show loading icon | `boolean` | `false` |
| disabled | Whether to disable switch | `boolean` | `false` |
| size | Size of switch | `string` | `30px` |
| active-color | Background color when active | `string` | `#1989fa` |
| inactive-color | Background color when inactive | `string` | `#fff` |
| active-value | Value when active | `any` | `true` |
| inactive-value | Value when inactive | `any` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Check status of Switch | `any` | `false` | - |
| loading | Whether to show loading icon | `boolean` | `false` | - |
| disabled | Whether to disable switch | `boolean` | `false` | - |
| size | Size of switch | `string` | `30px` | - |
| active-color | Background color when active | `string` | `#1989fa` | - |
| inactive-color | Background color when inactive | `string` | `#fff` | - |
| active-value | Value when active | `any` | `true` | - |
| inactive-value | Value when inactive | `any` | `false` | - |
### Events

View File

@ -174,33 +174,33 @@ In swipeable mode, you can switch tabs with swipe gestrue in the content
### Tabs Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Index of active tab | `string | number` | `0` |
| type | Can be set to `line` `card` | `string` | `line` |
| duration | Toggle tab's animation time | `number` | `0.3` | - |
| background | Background color | `string` | `white` |
| line-width | Width of tab line | `number | string` | Width of active tab |
| line-height | Height of tab line | `number | string` | `3px` |
| color | Tab color | `string` | `#f44` |
| title-active-color | Title active color | `string` | - |
| title-inactive-color | Title inactive color | `string` | - |
| swipe-threshold | Set swipe tabs threshold | `number` | `4` | - |
| offset-top | Offset top when use sticky mode | `number` | `0` |
| animated | Whether to change tabs with animation | `boolean` | `false` |
| border | Whether to show border when `type="line"` | `boolean` | `true` |
| ellipsis | Whether to ellipsis too long title | `boolean` | `true` |
| sticky | Whether to use sticky mode | `boolean` | `false` |
| swipeable | Whether to switch tabs with swipe gestrue in the content | `boolean` | `false` |
| lazy-render | Whether to enable tab content lazy render | `boolean` | `true` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Index of active tab | `string | number` | `0` | - |
| type | Can be set to `line` `card` | `string` | `line` | - |
| duration | Toggle tab's animation time | `number` | `0.3` | - | - |
| background | Background color | `string` | `white` | - |
| line-width | Width of tab line | `number | string` | Width of active tab | - |
| line-height | Height of tab line | `number | string` | `3px` | - |
| color | Tab color | `string` | `#f44` | - |
| title-active-color | Title active color | `string` | - | - |
| title-inactive-color | Title inactive color | `string` | - | - |
| swipe-threshold | Set swipe tabs threshold | `number` | `4` | - | - |
| offset-top | Offset top when use sticky mode | `number` | `0` | - |
| animated | Whether to change tabs with animation | `boolean` | `false` | - |
| border | Whether to show border when `type="line"` | `boolean` | `true` | - |
| ellipsis | Whether to ellipsis too long title | `boolean` | `true` | - |
| sticky | Whether to use sticky mode | `boolean` | `false` | - |
| swipeable | Whether to switch tabs with swipe gestrue in the content | `boolean` | `false` | - |
| lazy-render | Whether to enable tab content lazy render | `boolean` | `true` | - |
### Tab Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Identifier | `string | number` | Index of tab |
| title | Title | `string` | - |
| disabled | Whether to disable tab | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Identifier | `string | number` | Index of tab | - |
| title | Title | `string` | - | - |
| disabled | Whether to disable tab | `boolean` | `false` | - |
### Tabs Slots

View File

@ -192,7 +192,7 @@ export default {
| swipe-threshold | 滚动阈值,标签数量超过多少个可滚动 | `number` | `4` | - |
| offset-top | 粘性定位布局下与顶部的最小距离,单位 px | `number` | `0` | - |
| animated | 是否开启切换标签内容时的转场动画 | `boolean` | `false` | - |
| border | 是否显示标签栏外边框,仅在`type="line"`时有效 | `boolean` | `true` | 2.0.0 |
| border | 是否显示标签栏外边框,仅在`type="line"`时有效 | `boolean` | `true` | - |
| ellipsis | 是否省略过长的标题文字 | `boolean` | `true` | - |
| sticky | 是否使用粘性定位布局 | `boolean` | `false` | - |
| swipeable | 是否开启手势滑动切换 | `boolean` | `false` | - |

View File

@ -139,16 +139,16 @@ export default {
### Tabbar Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Identifier of current tab | `string | number` | `0` |
| fixed | Whether to fixed bottom | `boolean` | `true` |
| border | Whether to show border | `boolean` | `true` |
| z-index | Z-index | `number` | `1` |
| active-color | Color of active tab item | `string` | `#1989fa` |
| inactive-color | Color of inactive tab item | `string` | `#7d7e80` |
| route | Whether to enable route mode | `boolean` | `false` |
| 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` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Identifier of current tab | `string | number` | `0` | - |
| fixed | Whether to fixed bottom | `boolean` | `true` | - |
| border | Whether to show border | `boolean` | `true` | - |
| z-index | Z-index | `number` | `1` | - |
| active-color | Color of active tab item | `string` | `#1989fa` | - |
| inactive-color | Color of inactive tab item | `string` | `#7d7e80` | - |
| route | Whether to enable route mode | `boolean` | `false` | - |
| 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 Events
@ -158,15 +158,15 @@ export default {
### TabbarItem Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Identifier | `string | number` | Item index |
| icon | Icon name | `string` | - |
| dot | Whether to show red dot | `boolean` | - |
| info | Info message | `string | number` | - |
| url | Link | `string` | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Identifier | `string | number` | Item index | - |
| icon | Icon name | `string` | - | - |
| dot | Whether to show red dot | `boolean` | - | - |
| info | Info message | `string | number` | - | - |
| url | Link | `string` | - | - |
| to | Target route of the link, same as to of vue-router | `string | object` | - | - |
| replace | If true, the navigation will not leave a history record | `boolean` | `false` | - |
### TabbarItem Slots

View File

@ -149,11 +149,11 @@ export default {
|------|------|------|------|------|
| v-model | 当前选中标签的名称或索引值 | `string | number` | `0` | - |
| fixed | 是否固定在底部 | `boolean` | `true` | - |
| border | 是否显示外边框 | `boolean` | `true` | 2.0.0 |
| border | 是否显示外边框 | `boolean` | `true` | - |
| z-index | 元素 z-index | `number` | `1` | - |
| active-color | 选中标签的颜色 | `string` | `#1989fa` | - |
| inactive-color | 未选中标签的颜色 | `string` | `#7d7e80` | 2.0.0 |
| route | 是否开启路由模式 | `boolean` | `false` | 2.0.0 |
| inactive-color | 未选中标签的颜色 | `string` | `#7d7e80` | - |
| route | 是否开启路由模式 | `boolean` | `false` | - |
| safe-area-inset-bottom | 是否开启 iPhone X 底部安全区适配,需要在 `viewport` meta 标签中设置 `viewport-fit=cover` | `boolean` | `false` | - |
### Tabbar Events
@ -166,7 +166,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| name | 标签名称,作为匹配的标识符 | `string | number` | 当前标签的索引值 | 2.0.0 |
| name | 标签名称,作为匹配的标识符 | `string | number` | 当前标签的索引值 | - |
| icon | 图标名称或图片链接,可选值见 Icon 组件| `string` | - | - |
| dot | 是否显示小红点 | `boolean` | - | - |
| info | 图标右上角提示信息 | `string | number` | - | - |

View File

@ -73,15 +73,15 @@ Vue.use(Tag);
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Type, can be set to `primary` `success` `danger` `warning` | `string` | `default` |
| size | Size, can be set to `large` `medium` | `string` | - |
| color | Custom color | `string` | - |
| plain | Whether to be plain style | `boolean` | `false` |
| round | Whether to be round style | `boolean` | `false` |
| mark | Whether to be mark style | `boolean` | `false` |
| text-color | Text color | `string` | `white` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| type | Type, can be set to `primary` `success` `danger` `warning` | `string` | `default` | - |
| size | Size, can be set to `large` `medium` | `string` | - | - |
| color | Custom color | `string` | - | - |
| plain | Whether to be plain style | `boolean` | `false` | - |
| round | Whether to be round style | `boolean` | `false` | - |
| mark | Whether to be mark style | `boolean` | `false` | - |
| text-color | Text color | `string` | `white` | - |
### Slots

View File

@ -112,19 +112,19 @@ toast2.clear();
### Options
| Attribute | Description | Type | Default |
|------|------|------|------|
| type | Can be set to `loading` `success` `fail` `html` | `string` | `text` |
| position | Can be set to `top` `middle` `bottom` | `string` | `middle` |
| message | Message | `string` | `''` |
| icon | Custom icon | `string` | - |
| iconPrefix | Icon className prefix | `string` | `van-icon` |
| mask | Whether to show mask | `boolean` | `false` |
| forbidClick | Whether to forbid click background | `boolean` | `false` |
| closeOnClick | Whether to close after clicked | `boolean` | `false` |
| loadingType | Loading icon type, can be set to `spinner` | `string` | `circular` |
| duration | Toast duration(ms), won't disappear if value is 0 | `number` | `3000` |
| className | Custom className | `any` | - |
| onOpened | Callback function after opened | `Function` | - |
| onClose | Callback function after close | `Function` | - |
| getContainer | Return the mount node for Toast | `string | () => HTMLElement` | `body` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| type | Can be set to `loading` `success` `fail` `html` | `string` | `text` | - |
| position | Can be set to `top` `middle` `bottom` | `string` | `middle` | - |
| message | Message | `string` | `''` | - |
| icon | Custom icon | `string` | - | 2.0.1 |
| iconPrefix | Icon className prefix | `string` | `van-icon` | 2.0.9 |
| mask | Whether to show mask | `boolean` | `false` | - |
| forbidClick | Whether to forbid click background | `boolean` | `false` | - |
| closeOnClick | Whether to close after clicked | `boolean` | `false` | 2.1.5 |
| loadingType | Loading icon type, can be set to `spinner` | `string` | `circular` | - |
| duration | Toast duration(ms), won't disappear if value is 0 | `number` | `3000` | - |
| className | Custom className | `any` | - | - |
| onOpened | Callback function after opened | `Function` | - | - |
| onClose | Callback function after close | `Function` | - | - |
| getContainer | Return the mount node for Toast | `string | () => HTMLElement` | `body` | - |

View File

@ -125,6 +125,6 @@ toast2.clear();
| loadingType | 加载图标类型, 可选值为 `spinner` | `string` | `circular` | - |
| duration | 展示时长(ms),值为 0 时toast 不会消失 | `number` | `3000` | - |
| className | 自定义类名 | `any` | - | - |
| onOpened | 完全展示后的回调函数 | `Function` | - | 2.0.0 |
| onOpened | 完全展示后的回调函数 | `Function` | - | - |
| onClose | 关闭时的回调函数 | `Function` | - | - |
| getContainer | 指定挂载的节点,可以传入选择器,<br>或一个返回节点的函数 | `string | () => HTMLElement` | `body` | - |

View File

@ -59,12 +59,12 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| items | Required datasets for the component | `Item[]` | `[]` |
| height | Height | `string | number` | `300` |
| main-Active-index | The index of selected parent node | `number` | `0` |
| active-id | Id of selected item | `string | number | (string | number)[]` | `0` |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| items | Required datasets for the component | `Item[]` | `[]` | - |
| height | Height | `string | number` | `300` | - |
| main-Active-index | The index of selected parent node | `number` | `0` | - |
| active-id | Id of selected item | `string | number | (string | number)[]` | `0` | - |
### Events

View File

@ -109,23 +109,23 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| name | Input name | `string | number` | - |
| accept | Accepted file type | `string` | `image/*` |
| preview-size | Size of preview image | `string | number` | `80px` |
| preview-image | Whether to show image preview | `boolean` | `true` |
| preview-full-image | Whethe to show full screen image preview when click image | `boolean` | `true` |
| multiple | Whether to enable multiple selection pictures | `boolean` | `false` |
| disabled | Whether to disabled the upload | `boolean` | `false` |
| capture | Capturecan be set to `camera` | `string` | - |
| after-read | Hook after reading the file | `Function` | - |
| before-read | Hook before reading the file, return false to stop reading the file, can return Promise | `Function` | - |
| before-delete | Hook before delete the file, return false to stop reading the file, can return Promise | `Function` | - |
| max-size | Max size of file | `number` | - |
| max-count | Max count of image | `number` | - |
| result-type | Type of file read result, can be set to `dataUrl` `text` | `string` | `dataUrl` |
| upload-text | Upload text | `string` | - |
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Input name | `string | number` | - | 2.0.3 |
| accept | Accepted file type | `string` | `image/*` | - |
| preview-size | Size of preview image | `string | number` | `80px` | - |
| preview-image | Whether to show image preview | `boolean` | `true` | 2.1.5 |
| preview-full-image | Whethe to show full screen image preview when click image | `boolean` | `true` | - |
| multiple | Whether to enable multiple selection pictures | `boolean` | `false` | - |
| disabled | Whether to disabled the upload | `boolean` | `false` | - |
| capture | Capturecan be set to `camera` | `string` | - | - |
| after-read | Hook after reading the file | `Function` | - | - |
| before-read | Hook before reading the file, return false to stop reading the file, can return Promise | `Function` | - | - |
| before-delete | Hook before delete the file, return false to stop reading the file, can return Promise | `Function` | - | - |
| max-size | Max size of file | `number` | - | - |
| max-count | Max count of image | `number` | - | - |
| result-type | Type of file read result, can be set to `dataUrl` `text` | `string` | `dataUrl` | - |
| upload-text | Upload text | `string` | - | - |
| image-fit | Preview image fit mode | `string` | `cover` | 2.1.5 |
### Events

View File

@ -129,19 +129,19 @@ export default {
|------|------|------|------|------|
| name | 标识符,可以在回调函数的第二项参数中获取 | `string | number` | - | 2.0.3 |
| accept | 接受的文件类型 | `string` | `image/*` | - |
| preview-size | 预览图和上传区域的尺寸,默认单位为`px` | `string | number` | `80px` | 2.0.0 |
| preview-image | 是否在上传完成后展示预览图 | `boolean` | `true` | 2.0.0 |
| preview-size | 预览图和上传区域的尺寸,默认单位为`px` | `string | number` | `80px` | - |
| preview-image | 是否在上传完成后展示预览图 | `boolean` | `true` | - |
| preview-full-image | 是否在点击预览图后展示全屏图片预览 | `boolean` | `true` | 2.1.5 |
| multiple | 是否开启图片多选,部分安卓机型不支持 | `boolean` | `false` | 2.0.0 |
| multiple | 是否开启图片多选,部分安卓机型不支持 | `boolean` | `false` | - |
| disabled | 是否禁用文件上传 | `boolean` | `false` | - |
| capture | 图片选取模式,可选值为`camera`(直接调起摄像头) | `string` | - | 2.0.0 |
| capture | 图片选取模式,可选值为`camera`(直接调起摄像头) | `string` | - | - |
| after-read | 文件读取完成后的回调函数 | `Function` | - | - |
| before-read | 文件读取前的回调函数,返回`false`可终止文件读取,支持返回`Promise` | `Function` | - | - |
| before-delete | 文件删除前的回调函数,返回`false`可终止文件读取,支持返回`Promise` | `Function` | - | - |
| max-size | 文件大小限制,单位为`byte` | `number` | - | - |
| max-count | 文件上传数量限制 | `number` | - | 2.0.0 |
| max-count | 文件上传数量限制 | `number` | - | - |
| result-type | 文件读取结果类型,可选值为`text` | `string` | `dataUrl` | - |
| upload-text | 上传区域文字提示 | `string` | - | 2.0.0 |
| upload-text | 上传区域文字提示 | `string` | - | - |
| image-fit | 预览图裁剪模式,可选值见 [Image](#/zh-CN/image) 组件 | `string` | `cover` | 2.1.5 |
### Events