alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

[Doc] remove Accepted Values (#991)

Browse Source
This commit is contained in:
neverland
2018-05-05 10:57:26 +08:00
committed by GitHub
parent b39853f1bc
commit 3f8369e599
26 changed files with 243 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/markdown/en-US/button.md
+11 -11
View File
@@ -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
docs/markdown/en-US/cell.md
+1 -1
View File
@@ -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` |
docs/markdown/en-US/checkbox.md
+12 -12
View File
@@ -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
docs/markdown/en-US/contact.md
+9 -6
View File
@@ -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` |
docs/markdown/en-US/datetime-picker.md
+12 -12
View File
@@ -97,19 +97,19 @@ export default {
### API
| Attribute | Description | Type | Default | Accepted Values |
| Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------|
| type | Picker type | `String` | `datetime` | `date` `time` <br> `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
docs/markdown/en-US/field.md
+10 -10
View File
@@ -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`
docs/markdown/en-US/loading.md
+5 -5
View File
@@ -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` |
docs/markdown/en-US/notice-bar.md
+9 -9
View File
@@ -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
docs/markdown/en-US/number-keyboard.md
+11 -11
View File
@@ -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
docs/markdown/en-US/pagination.md
+9 -9
View File
@@ -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
docs/markdown/en-US/popup.md
+11 -11
View File
@@ -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
docs/markdown/en-US/steps.md
+9 -9
View File
@@ -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
docs/markdown/en-US/tab.md
+13 -13
View File
@@ -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