From 3f8369e599b5989cb8683eb9548a5703c29efa80 Mon Sep 17 00:00:00 2001 From: neverland Date: Sat, 5 May 2018 10:57:26 +0800 Subject: [PATCH] [Doc] remove Accepted Values (#991) --- docs/markdown/en-US/button.md | 22 +++++++++++----------- docs/markdown/en-US/cell.md | 2 +- docs/markdown/en-US/checkbox.md | 24 ++++++++++++------------ docs/markdown/en-US/contact.md | 15 +++++++++------ docs/markdown/en-US/datetime-picker.md | 24 ++++++++++++------------ docs/markdown/en-US/field.md | 20 ++++++++++---------- docs/markdown/en-US/loading.md | 10 +++++----- docs/markdown/en-US/notice-bar.md | 18 +++++++++--------- docs/markdown/en-US/number-keyboard.md | 22 +++++++++++----------- docs/markdown/en-US/pagination.md | 18 +++++++++--------- docs/markdown/en-US/popup.md | 22 +++++++++++----------- docs/markdown/en-US/steps.md | 18 +++++++++--------- docs/markdown/en-US/tab.md | 26 +++++++++++++------------- docs/markdown/zh-CN/button.md | 22 +++++++++++----------- docs/markdown/zh-CN/cell.md | 2 +- docs/markdown/zh-CN/checkbox.md | 24 ++++++++++++------------ docs/markdown/zh-CN/contact.md | 16 +++++++++------- docs/markdown/zh-CN/datetime-picker.md | 24 ++++++++++++------------ docs/markdown/zh-CN/field.md | 18 +++++++++--------- docs/markdown/zh-CN/loading.md | 10 +++++----- docs/markdown/zh-CN/notice-bar.md | 18 +++++++++--------- docs/markdown/zh-CN/number-keyboard.md | 22 +++++++++++----------- docs/markdown/zh-CN/pagination.md | 18 +++++++++--------- docs/markdown/zh-CN/popup.md | 22 +++++++++++----------- docs/markdown/zh-CN/steps.md | 18 +++++++++--------- docs/markdown/zh-CN/tab.md | 26 +++++++++++++------------- 26 files changed, 243 insertions(+), 238 deletions(-) diff --git a/docs/markdown/en-US/button.md b/docs/markdown/en-US/button.md index c01436e23..3aacaa54d 100644 --- a/docs/markdown/en-US/button.md +++ b/docs/markdown/en-US/button.md @@ -65,17 +65,17 @@ Use `tag` prop to custom button tag ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| type | Type | `String` | `default` | `primary` `danger` | -| size | Size | `String` | `normal` | `large` `small` `mini` | -| text | Text | `String` | - | - | -| tag | Tag | `String` | `button` | - | -| native-type | Native Type Attribute | `String` | `''` | - | -| disabled | Whether disable button | `Boolean` | `false` | - | -| loading | Whether show loading status | `Boolean` | `false` | - | -| block | Whether to set display block | `Boolean` | `false` | - | -| bottom-action | Whether to be action button | `Boolean` | `false` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| type | Can be set to `default` `primary` `danger` | `String` | `default` | +| size | Can be set to `normal` `large` `small` `mini` | `String` | `normal` | +| text | Text | `String` | - | +| tag | Tag | `String` | `button` | +| native-type | Native Type Attribute | `String` | `''` | +| disabled | Whether disable button | `Boolean` | `false` | +| loading | Whether show loading status | `Boolean` | `false` | +| block | Whether to set display block | `Boolean` | `false` | +| bottom-action | Whether to be action button | `Boolean` | `false` | ### Event diff --git a/docs/markdown/en-US/cell.md b/docs/markdown/en-US/cell.md index cf932c5b3..c42e93e3a 100644 --- a/docs/markdown/en-US/cell.md +++ b/docs/markdown/en-US/cell.md @@ -76,7 +76,7 @@ Vue.use(Cell).use(CellGroup); | label | Description below the title | `String` | - | | border | Whether to show inner border | `Boolean` | `true` | | center | Whether to center content vertically | `Boolean` | `true` | -| url | Link | `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 | `String` | `false` | | clickable | Whether to show click feedback when clicked | `Boolean` | `false` | diff --git a/docs/markdown/en-US/checkbox.md b/docs/markdown/en-US/checkbox.md index 4fff3cdf5..78b869eb7 100644 --- a/docs/markdown/en-US/checkbox.md +++ b/docs/markdown/en-US/checkbox.md @@ -91,21 +91,21 @@ export default { ### Checkbox API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Check status | `Boolean` | `false` | - | -| name | Checkbox name | `any` | - | - | -| disabled | Diable checkbox | `Boolean` | `false` | - | -| label-disabled | Whether to disable label click | `Boolean` | `false` | - | -| shape | Checkbox shape | `String` | `round` | `square` | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | Check status | `Boolean` | `false` | +| name | Checkbox name | `any` | - | +| disabled | Diable checkbox | `Boolean` | `false` | +| label-disabled | Whether to disable label click | `Boolean` | `false` | +| shape | Can be set to `round` `square` | `String` | `round` | ### CheckboxGroup API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Names of all checked checkboxes | `Array` | - | - | -| disabled | Disable all checkboxes | `Boolean` | `false` | - | -| max | Maximum amount of checked options | `Number` | `0`(Unlimited) | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| v-model | Names of all checked checkboxes | `Array` | - | +| disabled | Disable all checkboxes | `Boolean` | `false` | +| max | Maximum amount of checked options | `Number` | `0`(Unlimited) | ### Checkbox Event diff --git a/docs/markdown/en-US/contact.md b/docs/markdown/en-US/contact.md index f6e769a27..f0f49740f 100644 --- a/docs/markdown/en-US/contact.md +++ b/docs/markdown/en-US/contact.md @@ -132,14 +132,16 @@ export default { ### ContactCard API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| type | Type | `String` | `add` | `edit` | -| name | Name | `String` | - | - | -| tel | Phone | `String` | - | - | -| add-text | Add card text | `String` | `Add contact info` | - | + +| 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` | ### ContactList API + | Attribute | Description | Type | Default | |-----------|-----------|-----------|-------------|-------------| | v-model | Id of chosen contact | `String | Number` | - | @@ -171,6 +173,7 @@ export default { | delete | Triggered when click delete button | content：contact info | ### Contact Data Structure + | key | Description | Type | |-----------|-----------|-----------| | id | ID | `String | Number` | diff --git a/docs/markdown/en-US/datetime-picker.md b/docs/markdown/en-US/datetime-picker.md index 0662f2f88..3420d3a72 100644 --- a/docs/markdown/en-US/datetime-picker.md +++ b/docs/markdown/en-US/datetime-picker.md @@ -97,19 +97,19 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | +| Attribute | Description | Type | Default | |-----------|-----------|-----------|-------------|-------------| -| type | Picker type | `String` | `datetime` | `date` `time`
`year-month` | -| 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 | `Number` | `0` | - | -| max-hour | Max hour | `Number` | `23` | - | -| 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` `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 | `Number` | `0` | +| max-hour | Max hour | `Number` | `23` | +| 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` | ### Event diff --git a/docs/markdown/en-US/field.md b/docs/markdown/en-US/field.md index 073f1218e..2c6701298 100644 --- a/docs/markdown/en-US/field.md +++ b/docs/markdown/en-US/field.md @@ -111,16 +111,16 @@ Use button slot to insert button ### API Filed support all native properties of input tag，such as `maxlength`、`placeholder`、`readonly`、`autofocus` -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| type | Filed type | `String` | `text` | `number` `email` `textarea` `tel` `datetime` `date` `password` `url` | -| value | Filed value | `String` | - | - | -| label | Filed label | `String` | - | - | -| disabled | Disable field | `Boolean` | `false` | - | -| error | Whether to show error info | `Boolean` | `false` | - | -| error-message | Error message | `String` | `''` | - | -| autosize | Textarea auto resize，can accpet an object, e.g. { maxHeight: 100, minHeight: 50 } | `Boolean | Object` | `false` | - | -| icon | Right side Icon name | `String` | - | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| type | Input type | `String` | `text` | +| value | Filed value | `String` | - | +| label | Filed label | `String` | - | +| disabled | Disable field | `Boolean` | `false` | +| error | Whether to show error info | `Boolean` | `false` | +| error-message | Error message | `String` | `''` | +| autosize | Textarea auto resize，can accpet an object, e.g. { maxHeight: 100, minHeight: 50 } | `Boolean | Object` | `false` | +| icon | Right side Icon name | `String` | - | ### Event Filed support all native events of input tag，such as `focus`、`blur`、`keypress` diff --git a/docs/markdown/en-US/loading.md b/docs/markdown/en-US/loading.md index d4dae41f2..0cd650c26 100644 --- a/docs/markdown/en-US/loading.md +++ b/docs/markdown/en-US/loading.md @@ -25,8 +25,8 @@ Vue.use(Loading); ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| color | Color | `String` | `black` | `black` `white` | -| type | Type | `String` | `circular` | `spinner` | -| size | Size | `String` | `30px` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| color | Can be set to `black` `white` | `String` | `black` | | +| type | Can be set to `circular` `spinner` | `String` | `circular` | +| size | Size | `String` | `30px` | diff --git a/docs/markdown/en-US/notice-bar.md b/docs/markdown/en-US/notice-bar.md index de7a0e04e..d3cdce1a5 100644 --- a/docs/markdown/en-US/notice-bar.md +++ b/docs/markdown/en-US/notice-bar.md @@ -40,15 +40,15 @@ Vue.use(NoticeBar); ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| mode | Mode | String | `''` | `closeable` `link` | -| delay | Animation delay (s) | Number | `1` | - | -| speed | Scroll speed (px) | Number | `50` | - | -| scrollable | Whether to scroll content | Boolean | `true` | - | -| left-icon | Image url of left icon | String | - | - | -| color | Text color | String | `#f60` | - | -| background | Background color | String | `#fff7cc` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| mode | Mode, can be set to `closeable` `link` | `String` | `''` | +| delay | Animation delay (s) | `Number` | `1` | +| speed | Scroll speed (px/s) | `Number` | `50` | +| scrollable | Whether to scroll content | `Boolean` | `true` | +| left-icon | Image url of left icon | `String` | - | +| color | Text color | `String` | `#f60` | +| background | Background color | `String` | `#fff7cc` | ### Event diff --git a/docs/markdown/en-US/number-keyboard.md b/docs/markdown/en-US/number-keyboard.md index 178d1e0b8..3647f830e 100644 --- a/docs/markdown/en-US/number-keyboard.md +++ b/docs/markdown/en-US/number-keyboard.md @@ -61,17 +61,17 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| show | Whether to show keyboard | `Boolean` | - | - | -| theme | Keyboard theme | `String` | `Default` | `Custom` | -| title | Keyboard title | `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` | `-` | - | -| show-delete-key | Whether to show delete button | `Boolean` | `true` | - | -| hide-on-click-outside | Whether to hide keyboard when click outside | `Boolean` | `true` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| show | Whether to show keyboard | `Boolean` | - | +| theme | Keyboard theme，can be set to `default` `custom` | `String` | `default` | +| title | Keyboard title | `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` | `-` | +| show-delete-key | Whether to show delete button | `Boolean` | `true` | +| hide-on-click-outside | Whether to hide keyboard when click outside | `Boolean` | `true` | ### Event diff --git a/docs/markdown/en-US/pagination.md b/docs/markdown/en-US/pagination.md index 332913ddc..7887cd16f 100644 --- a/docs/markdown/en-US/pagination.md +++ b/docs/markdown/en-US/pagination.md @@ -52,15 +52,15 @@ export default { ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Current page number | `Number` | - | - | -| mode | Mode | `String` | `multi` | `simple` | -| items-per-page | Item number per page | `Number` | `10` | - | -| 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 | +|-----------|-----------|-----------|-------------| +| v-model | Current page number | `Number` | - | +| mode | Mode, can be set to `simple` `multi` | `String` | `multi` | +| items-per-page | Item number per page | `Number` | `10` | +| 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` | ### Event diff --git a/docs/markdown/en-US/popup.md b/docs/markdown/en-US/popup.md index 0f7c17d0a..fe6012540 100644 --- a/docs/markdown/en-US/popup.md +++ b/docs/markdown/en-US/popup.md @@ -37,17 +37,17 @@ Use `position` prop to set popup display position ### API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Whether to show popup | `Boolean` | `false` | - | -| overlay | Whether to show overlay | `Boolean` | `true` | - | -| position | Position | `String` | - | `top` `bottom` `right` `left` | -| overlay-class | Custom overlay class | `String` | `` | - | -| overlay-style | Custom overlay style | `Object` | - | - | -| close-on-click-overlay | Close popup when click overlay | `Boolean` | `true` | - | -| transition | Transition | `String` | `popup-slide` | - | -| lock-scroll | Whether to lock background scroll | `Boolean` | `true` | - | -| get-container | Return the mount node for Popup | `Function` | - | `() => HTMLElement` | +| 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` | - | +| overlay-class | Custom overlay class | `String` | `` | +| overlay-style | Custom overlay style | `Object` | - | +| close-on-click-overlay | Close popup when click overlay | `Boolean` | `true` | +| transition | Transition | `String` | `popup-slide` | +| lock-scroll | Whether to lock background scroll | `Boolean` | `true` | +| get-container | Return the mount node for Popup | `() => HTMLElement` | - | ### Event diff --git a/docs/markdown/en-US/steps.md b/docs/markdown/en-US/steps.md index 3daf6a28b..832b971fa 100644 --- a/docs/markdown/en-US/steps.md +++ b/docs/markdown/en-US/steps.md @@ -67,15 +67,15 @@ export default { ### Steps API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| active | Active step | `Number` | 0 | - | -| icon | Action step icon | `String` | - | - | -| icon-class | Icon class | `String` | - | - | -| title | Title | `String` | - | - | -| description | Description | `String` | - | - | -| direction | Direction | `String` | `horizontal` | `vertical` | -| active-color | Active step color | `String` | `#06bf04` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| active | Active step | `Number` | 0 | +| icon | Action step icon | `String` | - | +| icon-class | Icon class | `String` | - | +| title | Title | `String` | - | +| description | Description | `String` | - | +| direction | Can be set to `horizontal` `vertical` | `String` | `horizontal` | +| active-color | Active step color | `String` | `#06bf04` | ### Steps Slot diff --git a/docs/markdown/en-US/tab.md b/docs/markdown/en-US/tab.md index 7c2416f65..45d0abb9d 100644 --- a/docs/markdown/en-US/tab.md +++ b/docs/markdown/en-US/tab.md @@ -136,22 +136,22 @@ In swipeable mode, you can switch tabs with swipe gestrue in the content ### Tabs API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| v-model | Index of active tab | `String` `Number` | `0` | - | -| type | There are two style tabs, set this attribute to change tab style | `String` | `line` | `card` | -| duration | Toggle tab's animation time | `Number` | `0.2` | - | - | -| line-width | Width of tab line (px) | `Number` | Equal to current tab width | - | -| swipe-threshold | Set swipe tabs threshold | `Number` | `4` | - | - | -| sticky | Whether to use sticky mode | `Boolean` | `false` | - | -| swipeable | Whether to switch tabs with swipe gestrue in the content | `Boolean` | `false` | - | +| 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.2` | - | +| line-width | Width of tab line (px) | `Number` | Width of active tab | +| swipe-threshold | Set swipe tabs threshold | `Number` | `4` | - | +| sticky | Whether to use sticky mode | `Boolean` | `false` | +| swipeable | Whether to switch tabs with swipe gestrue in the content | `Boolean` | `false` | ### Tab API -| Attribute | Description | Type | Default | Accepted Values | -|-----------|-----------|-----------|-------------|-------------| -| title | Title | `String` | - | - | -| disabled | Whether to disable tab | `Boolean` | `false` | - | +| Attribute | Description | Type | Default | +|-----------|-----------|-----------|-------------| +| title | Title | `String` | - | +| disabled | Whether to disable tab | `Boolean` | `false` | ### Tab Slot diff --git a/docs/markdown/zh-CN/button.md b/docs/markdown/zh-CN/button.md index 51c134c22..8f21a12be 100644 --- a/docs/markdown/zh-CN/button.md +++ b/docs/markdown/zh-CN/button.md @@ -69,17 +69,17 @@ Vue.use(Button); ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| type | 按钮类型 | `String` | `default` | `primary` `danger` | -| size | 按钮尺寸 | `String` | `normal` | `large` `small` `mini` | -| text | 按钮文字 | `String` | - | - | -| tag | 按钮标签 | `String` | `button` | 任意`HTML`标签 | -| native-type | 按钮类型（原生） | `String` | - | - | -| disabled | 是否禁用 | `Boolean` | `false` | - | -| loading | 是否显示为加载状态 | `Boolean` | `false` | - | -| block | 是否为块级元素 | `Boolean` | `false` | - | -| bottom-action | 是否为底部行动按钮 | `Boolean` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| type | 按钮类型，可选值为 `default` `primary` `danger` | `String` | `default` | +| size | 按钮尺寸，可选值为 `normal` `large` `small` `mini` | `String` | `normal` | +| text | 按钮文字 | `String` | - | +| tag | 按钮 HTML 标签 | `String` | `button` | +| native-type | 按钮类型（原生） | `String` | - | +| disabled | 是否禁用 | `Boolean` | `false` | +| loading | 是否显示为加载状态 | `Boolean` | `false` | +| block | 是否为块级元素 | `Boolean` | `false` | +| bottom-action | 是否为底部行动按钮 | `Boolean` | `false` | ### Event diff --git a/docs/markdown/zh-CN/cell.md b/docs/markdown/zh-CN/cell.md index 53c23536f..8da816c9b 100644 --- a/docs/markdown/zh-CN/cell.md +++ b/docs/markdown/zh-CN/cell.md @@ -77,7 +77,7 @@ Vue.use(Cell).use(CellGroup); | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| -| icon | 左侧图标 (可选值见 Icon 组件) | `String` | - | +| icon | 左侧图标，可选值见 Icon 组件 | `String` | - | | title | 左侧标题 | `String` | - | | value | 右侧内容 | `String` | - | | label | 标题下方的描述信息 | `String` | - | diff --git a/docs/markdown/zh-CN/checkbox.md b/docs/markdown/zh-CN/checkbox.md index 5fa7386a8..57e5ed7df 100644 --- a/docs/markdown/zh-CN/checkbox.md +++ b/docs/markdown/zh-CN/checkbox.md @@ -95,21 +95,21 @@ export default { ### Checkbox API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 是否为选中状态 | `Boolean` | `false` | - | -| name | 标识 Checkbox 名称 | 任意类型 | - | - | -| disabled | 是否禁用单选框 | `Boolean` | `false` | - | -| label-disabled | 是否禁用单选框内容点击 | `Boolean` | `false` | - | -| shape | 形状 | `String` | `round` | `square` | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 是否为选中状态 | `Boolean` | `false` | +| name | 标识 Checkbox 名称 | `any` | - | +| disabled | 是否禁用单选框 | `Boolean` | `false` | +| label-disabled | 是否禁用单选框内容点击 | `Boolean` | `false` | +| shape | 形状，可选值为 `round` `square` | `String` | `round` | ### CheckboxGroup API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 所有选中项的 name | `Array` | - | - | -| disabled | 是否禁用所有单选框 | `Boolean` | `false` | - | -| max | 设置最大可选数 | `Number` | `0`（无限制） | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 所有选中项的 name | `Array` | - | +| disabled | 是否禁用所有单选框 | `Boolean` | `false` | +| max | 设置最大可选数 | `Number` | `0`（无限制） | ### Checkbox Event diff --git a/docs/markdown/zh-CN/contact.md b/docs/markdown/zh-CN/contact.md index 26bd45f20..8201a64b7 100644 --- a/docs/markdown/zh-CN/contact.md +++ b/docs/markdown/zh-CN/contact.md @@ -132,14 +132,16 @@ export default { ### ContactCard API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| type | 类型，分为添加和编辑两种样式 | `String` | `add` | `edit` | -| name | 联系人姓名 | `String` | - | - | -| tel | 联系人手机号 | `String` | - | - | -| add-text | 添加时的文案提示 | `String` | `添加订单联系人信息` | - | + +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| type | 类型，可选值为 `add` `edit` | `String` | `add` | +| name | 联系人姓名 | `String` | - | +| tel | 联系人手机号 | `String` | - | +| add-text | 添加时的文案提示 | `String` | `添加订单联系人信息` | ### ContactList API + | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------|-------------| | v-model | 当前选中联系人的 id | `String | Number` | - | @@ -154,7 +156,6 @@ export default { | edit | 点击编辑按钮时触发 | item: 当前联系人对象，index: 索引 | | select | 切换选中的联系人时触发 | item: 当前联系人对象，index: 索引 | - ### ContactEdit API | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------|-------------| @@ -174,6 +175,7 @@ export default { ### 数据格式 #### 联系人数据格式 + | key | 说明 | 类型 | |-----------|-----------|-----------| | id | 每位联系人的唯一标识 | `String | Number` | diff --git a/docs/markdown/zh-CN/datetime-picker.md b/docs/markdown/zh-CN/datetime-picker.md index e690de957..40042e14d 100644 --- a/docs/markdown/zh-CN/datetime-picker.md +++ b/docs/markdown/zh-CN/datetime-picker.md @@ -97,19 +97,19 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | +| 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------|-------------| -| type | 组件类型 | `String` | `datetime` | `date` `time`
`year-month` | -| min-date | 可选的最小日期 | `Date` | 十年前的 1 月 1 日 | - | -| max-date | 可选的最大日期 | `Date` | 十年后的 12 月 31 日 | - | -| min-hour | 可选的最小小时，针对 time 类型 | `Number` | `0` | - | -| max-hour | 可选的最大小时，针对 time 类型 | `Number` | `23` | - | -| title | 顶部栏标题 | `String` | `''` | - | -| loading | 是否显示加载状态 | `Boolean` | `false` | - | -| item-height | 选项高度 | `Number` | `44` | - | -| confirm-button-text | 确认按钮文字 | `String` | `确认` | - | -| cancel-button-text | 取消按钮文字 | `String` | `取消` | - | -| visible-item-count | 可见的选项个数 | `Number` | `5` | - | +| type | 类型，可选值为 `date` `time` `year-month` | `String` | `datetime` | +| min-date | 可选的最小日期 | `Date` | 十年前的 1 月 1 日 | +| max-date | 可选的最大日期 | `Date` | 十年后的 12 月 31 日 | +| min-hour | 可选的最小小时，针对 time 类型 | `Number` | `0` | +| max-hour | 可选的最大小时，针对 time 类型 | `Number` | `23` | +| title | 顶部栏标题 | `String` | `''` | +| loading | 是否显示加载状态 | `Boolean` | `false` | +| item-height | 选项高度 | `Number` | `44` | +| confirm-button-text | 确认按钮文字 | `String` | `确认` | +| cancel-button-text | 取消按钮文字 | `String` | `取消` | +| visible-item-count | 可见的选项个数 | `Number` | `5` | ### Event diff --git a/docs/markdown/zh-CN/field.md b/docs/markdown/zh-CN/field.md index e6d60a5b1..058aedee4 100644 --- a/docs/markdown/zh-CN/field.md +++ b/docs/markdown/zh-CN/field.md @@ -113,16 +113,16 @@ Vue.use(Field); ### API Filed 默认支持 Input 标签所有的原生属性，比如 `maxlength`、`placeholder`、`readonly`、`autofocus` 等 -| 参数 | 说明 | 类型 | 默认值 | 可选值 | +| 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------|-------------| -| type | 输入框类型 | `String` | `text` | `number` `email` `textarea` `tel` `datetime` `date` `password` `url` | -| value | 输入框的值 | `String` | - | - | -| label | 输入框标签 | `String` | - | - | -| disabled | 是否禁用输入框 | `Boolean` | `false` | - | -| error | 输入框是否有错误 | `Boolean` | `false` | - | -| error-message | 输入框底部错误提示文案 | `String` | `''` | - | -| autosize | 自适应内容高度，只对 textarea 有效，可传入对象，如 { maxHeight: 100, minHeight: 50 }，单位为 px | `Boolean | Object` | `false` | - | -| icon | 输入框尾部图标 (可选值见 Icon 组件) | `String` | - | - | +| type | 可设置为任意原生类型, 如 `number` `tel` `textarea` | `String` | `text` | +| value | 输入框的值 | `String` | - | +| label | 输入框标签 | `String` | - | +| disabled | 是否禁用输入框 | `Boolean` | `false` | +| error | 输入框是否有错误 | `Boolean` | `false` | +| error-message | 输入框底部错误提示文案 | `String` | `''` | +| autosize | 自适应内容高度，只对 textarea 有效，可传入对象，如 { maxHeight: 100, minHeight: 50 }，单位为 px | `Boolean | Object` | `false` | +| icon | 输入框尾部图标 (可选值见 Icon 组件) | `String` | - | ### Event Filed 默认支持 Input 标签所有的原生事件，如 `focus`、`blur`、`keypress` 等 diff --git a/docs/markdown/zh-CN/loading.md b/docs/markdown/zh-CN/loading.md index 1f1bc7fbb..bd8e00509 100644 --- a/docs/markdown/zh-CN/loading.md +++ b/docs/markdown/zh-CN/loading.md @@ -25,8 +25,8 @@ Vue.use(Loading); ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| color | 颜色 | `String` | `black` | `white` | -| type | 类型 | `String` | `circular` | `spinner` | -| size | 大小 | `String` | `30px` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| color | 颜色，可选值为 `block` `white` | `String` | `black` | +| type | 类型，可选值为 `circular` `spinner` | `String` | `circular` | +| size | 大小 | `String` | `30px` | diff --git a/docs/markdown/zh-CN/notice-bar.md b/docs/markdown/zh-CN/notice-bar.md index 58dbd5fa8..b9fdc1e84 100644 --- a/docs/markdown/zh-CN/notice-bar.md +++ b/docs/markdown/zh-CN/notice-bar.md @@ -44,15 +44,15 @@ Vue.use(NoticeBar); ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| mode | 通告栏模式 | String | `''` | `closeable` `link` | -| delay | 动画延迟时间，单位秒 | Number | `1` | - | -| speed | 滚动速率，单位px | Number | `50` | - | -| scrollable | 是否滚动 | Boolean | `true` | - | -| left-icon | 左侧图标图片链接 | String | - | - | -| color | 文本颜色 | String | `#f60` | - | -| background | 滚动条背景 | String | `#fff7cc` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| mode | 通告栏模式，可选值为 `closeable` `link` | `String` | `''` | +| delay | 动画延迟时间 (s) | `Number` | `1` | +| speed | 滚动速率 (px/s) | `Number` | `50` | +| scrollable | 是否在长度溢出时滚动播放 | `Boolean` | `true` | +| left-icon | 左侧图标图片 URL | `String` | - | +| color | 文本颜色 | `String` | `#f60` | +| background | 滚动条背景 | `String` | `#fff7cc` | ### Event diff --git a/docs/markdown/zh-CN/number-keyboard.md b/docs/markdown/zh-CN/number-keyboard.md index 89c2bfc2a..a082ee260 100644 --- a/docs/markdown/zh-CN/number-keyboard.md +++ b/docs/markdown/zh-CN/number-keyboard.md @@ -61,17 +61,17 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| show | 是否显示键盘 | `Boolean` | - | - | -| theme | 键盘样式风格 | `String` | `Default` | `Custom` | -| title | 键盘标题 | `String` | - | - | -| transition | 是否开启过场动画 | `Boolean` | `true` | - | -| z-index | 键盘 z-index | `Number` | `100` | - | -| extra-key | 左下角按键内容 | `String` | `''` | - | -| close-button-text | 关闭按钮文字，空则不展示 | `String` | `-` | - | -| show-delete-key | 是否展示删除按钮 | `Boolean` | `true` | - | -| hide-on-click-outside | 点击外部时是否收起键盘 | `Boolean` | `true` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| show | 是否显示键盘 | `Boolean` | - | +| theme | 样式风格，可选值为 `default` `custom` | `String` | `default` | +| title | 键盘标题 | `String` | - | +| transition | 是否开启过场动画 | `Boolean` | `true` | +| z-index | 键盘 z-index | `Number` | `100` | +| extra-key | 左下角按键内容 | `String` | `''` | +| close-button-text | 关闭按钮文字，空则不展示 | `String` | `-` | +| show-delete-key | 是否展示删除按钮 | `Boolean` | `true` | +| hide-on-click-outside | 点击外部时是否收起键盘 | `Boolean` | `true` | ### Event diff --git a/docs/markdown/zh-CN/pagination.md b/docs/markdown/zh-CN/pagination.md index 693ba0bd3..d44f55c91 100644 --- a/docs/markdown/zh-CN/pagination.md +++ b/docs/markdown/zh-CN/pagination.md @@ -54,15 +54,15 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 当前页码 | `Number` | - | - | -| mode | 显示模式 | `String` | `multi` | `simple` | -| items-per-page | 每页记录数 | `Number` | `10` | - | -| previous-text | 上一页 | `String` | `上一页` | - | -| next-text | 下一页 | `String` | `下一页` | - | -| show-page-size | 显示的页码个数 | `Number` | `5` | - | -| force-ellipses | 显示省略号 | `Boolean` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 当前页码 | `Number` | - | +| mode | 显示模式，可选值为 `simple` `multi` | `String` | `multi` | +| items-per-page | 每页记录数 | `Number` | `10` | +| previous-text | 上一页 | `String` | `上一页` | +| next-text | 下一页 | `String` | `下一页` | +| show-page-size | 显示的页码个数 | `Number` | `5` | +| force-ellipses | 显示省略号 | `Boolean` | `false` | ### Event diff --git a/docs/markdown/zh-CN/popup.md b/docs/markdown/zh-CN/popup.md index f1fc0db58..56380fb8e 100644 --- a/docs/markdown/zh-CN/popup.md +++ b/docs/markdown/zh-CN/popup.md @@ -37,17 +37,17 @@ export default { ### API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 当前组件是否显示 | `Boolean` | `false` | - | -| overlay | 是否显示背景蒙层 | `Boolean` | `true` | - | -| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | - | -| position | Popup 位置 | `String` | - | `top` `bottom` `right` `left` | -| overlay-class | 自定义蒙层 class | `String` | `` | - | -| overlay-style | 自定义蒙层样式 | `Object` | `` | - | -| close-on-click-overlay | 点击蒙层是否关闭 Popup | `Boolean` | `true` | - | -| transition | transition 名称 | `String` | `popup-slide` | - | -| get-container | 指定弹出层挂载的 HTML 节点 | `Function` | - | `() => HTMLElement` | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 当前组件是否显示 | `Boolean` | `false` | +| overlay | 是否显示背景蒙层 | `Boolean` | `true` | +| lock-scroll | 是否锁定背景滚动 | `Boolean` | `true` | +| position | 可选值为 `top` `bottom` `right` `left` | `String` | - | +| overlay-class | 自定义蒙层 class | `String` | `` | +| overlay-style | 自定义蒙层样式 | `Object` | `` | +| close-on-click-overlay | 点击蒙层是否关闭 Popup | `Boolean` | `true` | +| transition | transition 名称 | `String` | `popup-slide` | +| get-container | 指定弹出层挂载的 HTML 节点 | `() => HTMLElement` | - | ### Event diff --git a/docs/markdown/zh-CN/steps.md b/docs/markdown/zh-CN/steps.md index 47b4c3467..1264d8dcc 100644 --- a/docs/markdown/zh-CN/steps.md +++ b/docs/markdown/zh-CN/steps.md @@ -70,15 +70,15 @@ export default { ### Steps API -| 参数 | 说明 | 类型 | 默认值 | 可选值 | -|-----------|-----------|-----------|-------------|-------------| -| active | 当前步骤，起始值为0 | `Number` | - | - | -| icon | 当前步骤的icon | `String` | - | - | -| icon-class | 当前步骤栏为icon添加的类 | `String` | - | - | -| title | 当前步骤标题 | `String` | - | - | -| description | 当前步骤描述 | `String` | - | - | -| direction | 显示方向 | `String` | `horizontal` | `vertical` | -| active-color | active状态颜色 | `String` | `#06bf04` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| active | 当前步骤 | `Number` | 0 | +| title | 描述栏标题 | `String` | - | +| description | 描述栏文字 | `String` | - | +| icon | 描述栏图标 | `String` | - | +| icon-class | 图标额外类名 | `String` | - | +| direction | 显示方向，可选值为 `horizontal` `vertical` | `String` | `horizontal` | +| active-color | 激活状态颜色 | `String` | `#06bf04` | ### Steps Slot diff --git a/docs/markdown/zh-CN/tab.md b/docs/markdown/zh-CN/tab.md index 6c8c7dabf..9a8b4b19d 100644 --- a/docs/markdown/zh-CN/tab.md +++ b/docs/markdown/zh-CN/tab.md @@ -138,22 +138,22 @@ export default { ### Tabs API -| 参数 | 说明 | 类型 | 默认值 | 可选 | -|-----------|-----------|-----------|-------------|-------------| -| v-model | 当前激活的 tab | `String` `Number` | `0` | - | -| type | Tab 样式类型 | `String` | `line` | `card` | -| duration | 切换 tab 的动画时间 | `Number` | `0.2` | - | -| line-width | 底部条宽度（px） | `Number` | 与当前 Tab 等宽 | - | -| swipe-threshold | 滚动阀值，设置 Tab 超过多少个可滚动 | `Number` | `4` | - | -| sticky | 是否使用粘性定位布局 | `Boolean` | `false` | - | -| swipeable | 是否可以滑动内容切换 | `Boolean` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| v-model | 当前激活标签的索引 | `String` `Number` | `0` | +| type | 样式类型，可选值为 `line` `card` | `String` | `line` | +| duration | 切换 tab 的动画时间 | `Number` | `0.2` | +| line-width | 底部条宽度 (px) | `Number` | 与当前标签等宽 | +| swipe-threshold | 滚动阀值，设置 Tab 超过多少个可滚动 | `Number` | `4` | +| sticky | 是否使用粘性定位布局 | `Boolean` | `false` | +| swipeable | 是否可以滑动内容切换 | `Boolean` | `false` | ### Tab API -| 参数 | 说明 | 类型 | 默认值 | 可选 | -|-----------|-----------|-----------|-------------|-------------| -| title | 标题 | `String` | - | - | -| disabled | 是否禁用标签 | `Boolean` | `false` | - | +| 参数 | 说明 | 类型 | 默认值 | +|-----------|-----------|-----------|-------------| +| title | 标题 | `String` | - | +| disabled | 是否禁用标签 | `Boolean` | `false` | ### Tab Slot