Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions document/components/docs/en-US/action-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| data | the data list to display | Array | - | [] |
| active | the highlighted item's index | Number | - | -1 |
| pickerStyle | Picker style | Boolean | true/false | false |
| visible<sup>1.8.1</sup> | whether visible. Bind to `v-model` | Boolean | true/false | false |

* `data` sub configuration

Expand All @@ -158,3 +159,10 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| - | - | - | - |
| cancel | triggers when clicking the cancel button | - | - |
| select | triggers when clicking some item | the clicked item - data[index] | the index of the clicked item |

### Instance methods

| Method name | Description |
| - | - |
| show | show |
| hide | hide |
3 changes: 3 additions & 0 deletions document/components/docs/en-US/cascade-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,7 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| confirmTxt | the text of the confirm button | String | '确定' | - |
| swipeTime | the duration of the momentum animation when user flicks the wheel of the picker, Unit: ms | Number | 2500 | - |
| alias | configure the alias of `value` and `text`, used as same as the alias of `Picker` component | Object | {} | { value: 'id', text: 'name'} |
| visible<sup>1.8.1</sup> | whether visible. Bind to `v-model` | Boolean | true/false | false |

* `data` sub configuration

Expand All @@ -249,4 +250,6 @@ __Notice:__ Cause this component used create-api, so you should read [create-api

| Method name | Description | Parameters 1 | Parameters 2 |
| - | - | - | - |
| show | show | - | - |
| hide | hide | - | - |
| setData | reset the cascading data and selected index | Array, the cascading data | Array, the indexes of selected item in each column |
6 changes: 3 additions & 3 deletions document/components/docs/en-US/date-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| cancelTxt | the text of the cancel button | String | - | '取消' | - |
| confirmTxt | the text of the confirm button | String | - | '确定' | - |
| swipeTime | the duration of the momentum animation when user flicks the wheel of the picker, Unit: ms | Number | - | 2500 | - |
| alias | configure the alias of `value` and `text` | Object | - | {} | { value: 'id', text: 'name'} |
| visible<sup>1.8.1</sup> | whether visible. Bind to `v-model` | Boolean | true/false | false | - |

* `format` sub configuration

Expand All @@ -270,5 +270,5 @@ __Notice:__ Cause this component used create-api, so you should read [create-api

| Method name | Description |
| - | - |
| show | show picker |
| hide | hide picker |
| show | show |
| hide | hide |
8 changes: 8 additions & 0 deletions document/components/docs/en-US/dialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| showClose | whether to show close button | Boolean | true/false | false |
| confirmBtn | confirm button configuration | Object/String | - | { text: '确定', active: true, href: 'javascript:;' } |
| cancelBtn | cancel button configuration | Object/String | - | { text: '取消', active: false, href: 'javascript:;' } |
| visible<sup>1.8.1</sup> | whether visible. Bind to `v-model` | Boolean | true/false | false |

* `confirmBtn` sub configuration

Expand Down Expand Up @@ -194,3 +195,10 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| confirm | triggers when the confirm button is clicked | e - event target |
| cancel | triggers when the cancel button is clicked | e - event target |
| close | triggers when the close button is clicked | e - event target |

### Instance methods

| Method name | Description |
| - | - |
| show | show |
| hide | hide |
3 changes: 2 additions & 1 deletion document/components/docs/en-US/drawer.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ __Notice:__ Drawer component's container element should be be a relative or abso
| title | title | String | - | '' |
| data | data source | Array | - | [] |
| selected-index | initial selected index | Array | - | [] |
| visible<sup>1.8.1</sup> | whether visible. Bind to `v-model` | Boolean | true/false | false |

- `data` sub configuration

Expand Down Expand Up @@ -199,6 +200,6 @@ __Notice:__ Drawer component's container element should be be a relative or abso

| Method name | Description | Parameters 1 | Parameters 2 | Parameters 3 |
| - | - | - | - | - |
| refill | refill data, change one Panel's data source | the Panel index | the data source | default selected index (Optional, recommended do not specify a value) |
| show | show | - | - | - |
| hide | hide | - | - | - |
| refill | refill data, change one Panel's data source | the Panel index | the data source | default selected index (Optional, recommended do not specify a value) |
5 changes: 3 additions & 2 deletions document/components/docs/en-US/picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| confirmTxt | the text of the confirm button | String | '确定' | - |
| swipeTime | the duration of the momentum animation when user flicks the wheel of the picker, Unit: ms | Number | 2500 | - |
| alias | configure the alias of `value` and `text` | Object | {} | { value: 'id', text: 'name'} |
| visible<sup>1.8.1</sup> | whether visible. Bind to `v-model` | Boolean | true/false | false |

* `data` sub configuration

Expand All @@ -210,5 +211,5 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| Method name | Description | Parameters 1 | Parameters 2 |
| - | - | - | - |
| setData | set options in picker| Array, texts and values of options of each columns of picker | Array, indexes of selected item in each column of picker |
| show | show picker | - | - |
| hide | hide picker | - | - |
| show | show | - | - |
| hide | hide | - | - |
8 changes: 8 additions & 0 deletions document/components/docs/en-US/popup.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ __Notice:__ All the components above used create-api, so you should read [create

| Attribute | Description | Type | Accepted Values | Default |
| - | - | - | - | - |
| visible<sup>1.8.1</sup> | whether visible. Bind to `v-model` | Boolean | true/false | false |
| type | the type of popup | String | - | '' |
| mask | whether to show background layer | Boolean | true/false | true |
| content | content, HTML string, valid when there's no slot | String | - | '' |
Expand All @@ -138,3 +139,10 @@ __Notice:__ All the components above used create-api, so you should read [create
| Event Name | Description | Parameters |
| - | - | - |
| mask-click | triggers when the background layer is clicked | click event target |

### Instance methods

| Method name | Description |
| - | - |
| show | show |
| hide | hide |
7 changes: 4 additions & 3 deletions document/components/docs/en-US/segment-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,8 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| confirmTxt | the text of the confirm button | String | '确定' | - |
| nextTxt | the text of the next button | String | '下一步' | - |
| prevTxt | the text of the prev button | String | '下一步' | - |
| swipeTime<sup>1.8.1</sup> | the duration of the momentum animation when user flicks the wheel of the picker, Unit: ms | Number | 2500 | - |
| visible<sup>1.8.1</sup> | whether visible. Bind to `v-model` | Boolean | true/false | false |

* `data` sub configuration

Expand All @@ -146,10 +148,9 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| prev | triggers when clicking the prev button | the index of current picker, Number | - | - | - |
| change | triggers when the roller scrolls | pickerIndex: Number, the index of current picker | index: Number, index of current scrolling roller | selectedIndex: Number, index of selected item in current column |


### Methods

| Method name | Description |
| - | - |
| show | show picker |
| hide | hide picker |
| show | show |
| hide | hide |
9 changes: 7 additions & 2 deletions document/components/docs/en-US/time-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,15 @@ __Notice:__ Cause this component used create-api, so you should read [create-api

| Attribute | Description | Type | Default |
| - | - | - | - |
| title | title | String | '选择时间' |
| swipeTime | the duration of the momentum animation when user flicks the wheel of the picker, Unit: ms | Number | 2500 |
| delay | minutes that postponed backwards from now, which determines the minimal optional time| Number | 15 |
| day | date configuration | Object | { len: 3, filter: ['今日'], format: 'M月d日' } |
| showNow | whether to display current time | Boolean | true |
| minuteStep | step of the minute | Number | 10 |
| title | title | String | '选择时间' |
| cancelTxt<sup>1.8.1</sup> | the text of the cancel button | String | '取消' |
| confirmTxt<sup>1.8.1</sup> | the text of the confirm button | String | '确定' |
| swipeTime | the duration of the momentum animation when user flicks the wheel of the picker, Unit: ms | Number | 2500 |
| visible<sup>1.8.1</sup> | whether visible. Bind to `v-model` | Boolean | false |

* `day` sub configuration

Expand All @@ -171,3 +174,5 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| Method name | Description | Parameters |
| - | - | - |
| setTime | manually set time displayed in time-picker with with the time stamp as time format | time stamp |
| show | show | - |
| hide | hide | - |
8 changes: 8 additions & 0 deletions document/components/docs/en-US/toast.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,17 @@ __Notice:__ Cause this component used create-api, so you should read [create-api
| mask | whether to show mask layer | Boolean | true/false | false |
| txt | tip text | String | - | '' |
| time | display duration, millisecond | Number | - | 3000 |
| visible<sup>1.8.1</sup> | whether visible. Bind to `v-model` | Boolean | true/false | false |

### Events

| Event Name | Description |
| - | - |
| timeout | triggers when the display time is out |

### Instance methods

| Method name | Description |
| - | - |
| show | show |
| hide | hide |
8 changes: 8 additions & 0 deletions document/components/docs/zh-CN/action-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| data | 需要展示的数据列表 | Array | - | [] |
| active | 高亮第几个选项 | Number | - | -1 |
| pickerStyle | Picker 样式 | Boolean | true/false | false |
| visible<sup>1.8.1</sup> | 显示状态,是否可见。`v-model`绑定值 | Boolean | true/false | false |

* `data` 子配置项

Expand All @@ -158,3 +159,10 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| - | - | - | - |
| cancel | 点击取消 | - | - |
| select | 点击某项 | 点击项 item,即 data[index] | 点击项的索引值 index |

### 实例方法

| 方法名 | 说明 |
| - | - |
| show | 显示 |
| hide | 隐藏 |
3 changes: 3 additions & 0 deletions document/components/docs/zh-CN/cascade-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| confirmTxt | 确定按钮文案 | String | '确定' | - |
| swipeTime | 快速滑动选择器滚轮时,惯性滚动动画的时长,单位:ms | Number | 2500 | - |
| alias | 配置`value`和`text`的别名,用法同`Picker`组件 | Object | {} | { value: 'id', text: 'name'} |
| visible<sup>1.8.1</sup> | 显示状态,是否可见。`v-model`绑定值 | Boolean | false | false |

* `data`子配置项

Expand All @@ -240,3 +241,5 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| 方法名 | 说明 | 参数1 | 参数2 |
| - | - | - | - |
| setData | 重置数据和选中的索引 | 级联树形数据结构,Array类型 | 每列选中的索引,Array类型 |
| show | 显示 | - | - |
| hide | 隐藏 | - | - |
12 changes: 6 additions & 6 deletions document/components/docs/zh-CN/date-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,11 +241,11 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| startColumn | 起始列 | String | year/month/date/hour/minute/second| year | hour |
| columnCount | 列数 | Number | - | 3 | 6 |
| format<sup>1.8.0+</sup> | 日期格式 | Object | - | { year: 'YYYY', month: 'M', date: 'D', hour: 'hh', minute: 'mm', second: 'ss' } | { year: 'YY年', month: 'MM月', date: '第 D 日' } |
| title | 标题 | String | - | '' | - |
| cancelTxt | 取消按钮文案 | String | - | '取消' | - |
| confirmTxt | 确定按钮文案 | String | - | '确定' | - |
| title | 标题 | String | - | '' | '时间选择' |
| cancelTxt | 取消按钮文案 | String | - | '取消' | '返回' |
| confirmTxt | 确定按钮文案 | String | - | '确定' | '选择' |
| swipeTime | 快速滑动选择器滚轮时,惯性滚动动画的时长,单位:ms | Number | - | 2500 | - |
| alias | 配置`value`和`text`的别名,用法同`Picker`组件 | Object | - | {} | { value: 'id', text: 'name'} |
| visible<sup>1.8.1</sup> | 显示状态,是否可见。`v-model`绑定值 | Boolean | true/false | false | - |

* `format` 子配置项

Expand All @@ -270,5 +270,5 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请

| 方法名 | 说明 |
| - | - |
| show | 显示选择器 |
| hide | 隐藏选择器 |
| show | 显示 |
| hide | 隐藏 |
8 changes: 8 additions & 0 deletions document/components/docs/zh-CN/dialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| showClose | 是否显示关闭按钮 | Boolean | true/false | false |
| confirmBtn | 确认按钮参数配置 | Object/String | - | { text: '确定', active: true, href: 'javascript:;' } |
| cancelBtn | 取消按钮参数配置 | Object/String | - | { text: '取消', active: false, href: 'javascript:;' } |
| visible<sup>1.8.1</sup> | 显示状态,是否可见。`v-model`绑定值 | Boolean | true/false | false |

* `confirmBtn` 子配置项

Expand Down Expand Up @@ -194,3 +195,10 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| confirm | 点击确认按钮后触发 | 事件对象 e |
| cancel | 点击取消按钮后触发 | 事件对象 e |
| close | 点击关闭按钮后触发 | 事件对象 e |

### 实例方法

| 方法名 | 说明 |
| - | - |
| show | 显示 |
| hide | 隐藏 |
3 changes: 2 additions & 1 deletion document/components/docs/zh-CN/drawer.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ __注:__ 组件依赖父容器相对定位或者绝对定位,因为 Drawer
| title | 标题 | String | - | '' |
| data | 数据源 | Array | - | [] |
| selected-index | 初始选择索引 | Array | - | [] |
| visible<sup>1.8.1</sup> | 显示状态,是否可见。`v-model`绑定值 | Boolean | true/false | false |

- `data` 子配置项

Expand Down Expand Up @@ -201,6 +202,6 @@ __注:__ 组件依赖父容器相对定位或者绝对定位,因为 Drawer

| 方法名 | 说明 | 参数1 | 参数2 | 参数3 |
| - | - | - | - | - |
| refill | 填充数据,改变某个 Panel 数据 | 要改变的 Panel 的索引 | 填充数据 | 默认选中项(可选,建议不填) |
| show | 显示 | - | - | - |
| hide | 隐藏 | - | - | - |
| refill | 填充数据,改变某个 Panel 数据 | 要改变的 Panel 的索引 | 填充数据 | 默认选中项(可选,建议不填) |
5 changes: 3 additions & 2 deletions document/components/docs/zh-CN/picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| confirmTxt | 确定按钮文案 | String | '确定' | - |
| swipeTime | 快速滑动 picker 滚轮时,惯性滚动动画的时长,单位:ms | Number | 2500 | - |
| alias | 配置`value`和`text`的别名 | Object | {} | { value: 'id', text: 'name'} |
| visible<sup>1.8.1</sup> | 显示状态,是否可见。`v-model`绑定值 | Boolean | true/false | false |

* `data`子配置项

Expand All @@ -210,5 +211,5 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| 方法名 | 说明 | 参数1 | 参数2 |
| - | - | - | - |
| setData | 设置picker可选项 | picker每列可选项的文案和值,Array类型 | picker每列选中的索引,Array类型 |
| show | 显示选择器 | - | - |
| hide | 隐藏选择器 | - | - |
| show | 显示 | - | - |
| hide | 隐藏 | - | - |
8 changes: 8 additions & 0 deletions document/components/docs/zh-CN/popup.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ __注:__ 以上组件都是基于 create-api 实现,所以在使用之前,

| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| - | - | - | - | - |
| visible<sup>1.8.1</sup> | 显示状态,是否可见。`v-model`绑定值 | Boolean | true/false | false |
| type | 弹层类型 | String | - | '' |
| mask | 是否显示背景层 | Boolean | true/false | true |
| content | 内容,HTML 字符串,在无插槽的时候有效 | String | - | '' |
Expand All @@ -125,3 +126,10 @@ __注:__ 以上组件都是基于 create-api 实现,所以在使用之前,
| 事件名 | 说明 | 参数 |
| - | - | - |
| mask-click | 背景层点击 | 点击事件对象 |

### 实例方法

| 方法名 | 说明 |
| - | - |
| show | 显示 |
| hide | 隐藏 |
10 changes: 6 additions & 4 deletions document/components/docs/zh-CN/segment-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,13 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| 参数 | 说明 | 类型 | 默认值 | 示例 |
| - | - | - | - | - |
| data | 定义各个选择器的组件名和属性 | Array | [] | - |
| nextTxt | 下一步按钮文案 | String | '下一步' | - |
| prevTxt | 上一步按钮文案 | String | '下一步' | - |
| title | 标题 | String | '' | - |
| cancelTxt | 取消按钮文案 | String | '取消' | - |
| confirmTxt | 确定按钮文案 | String | '确定' | - |
| nextTxt | 下一步按钮文案 | String | '下一步' | - |
| prevTxt | 上一步按钮文案 | String | '下一步' | - |
| swipeTime<sup>1.8.1</sup> | 快速滑动选择器滚轮时,惯性滚动动画的时长,单位:ms | Number | 2500 | - |
| visible<sup>1.8.1</sup> | 显示状态,是否可见。`v-model`绑定值 | Boolean | true/false | false |

* `data` 子配置项

Expand All @@ -151,5 +153,5 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请

| 方法名 | 说明 |
| - | - |
| show | 显示选择器 |
| hide | 隐藏选择器 |
| show | 显示 |
| hide | 隐藏 |
9 changes: 7 additions & 2 deletions document/components/docs/zh-CN/time-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,12 +133,15 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请

| 参数 | 说明 | 类型 | 默认值 |
| - | - | - | - |
| title | 标题 | String | '选择时间' |
| swipeTime | 快速滑动选择器滚轮时,惯性滚动动画的时长,单位:ms | Number | 2500 |
| delay | 将当前时间向后推算的分钟数,决定了最小可选时间 | Number | 15 |
| day | 日期配置 | Object | { len: 3, filter: ['今日'], format: 'M月d日' } |
| showNow | 是否显示当前时间 | Boolean | true |
| minuteStep | 分钟数的步长 | Number | 10 |
| title | 标题 | String | '选择时间' |
| cancelTxt<sup>1.8.1</sup> | 取消按钮文案 | String | '取消' |
| confirmTxt<sup>1.8.1</sup> | 确定按钮文案 | String | '确定' |
| swipeTime | 快速滑动选择器滚轮时,惯性滚动动画的时长,单位:ms | Number | 2500 |
| visible<sup>1.8.1</sup> | 显示状态,是否可见。`v-model`绑定值 | Boolean | false |

* `day`子配置项

Expand All @@ -161,3 +164,5 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| 方法名 | 说明 | 参数 |
| - | - | - |
| setTime | 手动设置time-picker组件显示的时间,数据格式为时间戳 | 时间戳 |
| show | 显示 | - |
| hide | 隐藏 | - |
8 changes: 8 additions & 0 deletions document/components/docs/zh-CN/toast.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请

| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| - | - | - | - | - |
| visible<sup>1.8.1</sup> | 显示状态,是否可见。`v-model`绑定值 | Boolean | true/false | false |
| type | 类型(对应不同的 icon) | String | loading/correct/error/warn | loading |
| mask | 遮罩 | Boolean | true/false | false |
| txt | 提示信息 | String | - | '' |
Expand All @@ -94,3 +95,10 @@ __注:__ 由于此组件基于 create-api 实现,所以在使用之前,请
| 事件名 | 说明 |
| - | - |
| timeout | 当显示时间结束时派发 |

### 实例方法

| 方法名 | 说明 |
| - | - |
| show | 显示 |
| hide | 隐藏 |
2 changes: 1 addition & 1 deletion document/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import App from './App.vue'
import router from './router'
import './common/js/highlight'

// TODO 需要使用 vConsole 的同学请打开注释即可
// 需要使用 vConsole 的同学请打开注释即可
/* eslint-disable no-unused-vars */
// import vConsole from 'vconsole'

Expand Down
Loading