[Improvement] Reorganize document (#1066)

2018-05-15 10:39:01 +08:00
parent b1142fd862
commit e8aad7246c
124 changed files with 181 additions and 186 deletions
@@ -0,0 +1,120 @@
+## DatetimePicker
+
+### Install
+``` javascript
+import { DatetimePicker } from 'vant';
+
+Vue.use(DatetimePicker);
+```
+
+### Usage
+
+#### Choose DateTime
+
+```html
+<van-datetime-picker
+  v-model="currentDate"
+  type="datetime"
+  :min-date="minDate"
+  :max-date="maxDate"
+/>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      minHour: 10,
+      maxHour: 20,
+      minDate: new Date(),
+      maxDate: new Date(2019, 10, 1),
+      currentDate: new Date()
+    };
+  }
+};
+```
+
+#### Choose Date
+
+```html
+<van-datetime-picker
+  v-model="currentDate"
+  type="date"
+  :min-date="minDate"
+/>
+```
+
+```js
+export default {
+  data() {
+    return {
+      currentDate: new Date()
+    };
+  }
+}
+```
+
+#### Choose Year-Month
+
+```html
+<van-datetime-picker
+  v-model="currentDate"
+  type="year-month"
+  :min-date="minDate"
+/>
+```
+
+```js
+export default {
+  data() {
+    return {
+      currentDate: new Date()
+    };
+  }
+}
+```
+
+#### Choose Time
+
+```html
+<van-datetime-picker
+  v-model="currentDate"
+  type="time"
+  :min-hour="minHour"
+  :max-hour="maxHour"
+/>
+```
+
+```js
+export default {
+  data() {
+    return {
+      currentDate: '12:00'
+    };
+  }
+}
+```
+
+### API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|-------------|
+| 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
+
+| Event | Description | Arguments |
+|-----------|-----------|-----------|
+| change | Triggered when value changed | picker: picker instance |
+| confirm | Triggered when click confirm button | value: current value |
+| cancel | Triggered when click cancel button | - |
@@ -0,0 +1,133 @@
+## DatetimePicker 时间选择
+
+### 使用指南
+``` javascript
+import { DatetimePicker } from 'vant';
+
+Vue.use(DatetimePicker);
+```
+
+### 代码演示
+
+#### 选择完整时间
+
+```html
+<van-datetime-picker
+  v-model="currentDate"
+  type="datetime"
+  :min-date="minDate"
+  :max-date="maxDate"
+/>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      minHour: 10,
+      maxHour: 20,
+      minDate: new Date(),
+      maxDate: new Date(2019, 10, 1),
+      currentDate: new Date()
+    };
+  }
+};
+```
+
+#### 选择日期（年月日）
+
+```html
+<van-datetime-picker
+  v-model="currentDate"
+  type="date"
+  :min-date="minDate"
+/>
+```
+
+```js
+export default {
+  data() {
+    return {
+      currentDate: new Date()
+    };
+  }
+}
+```
+
+#### 选择日期（年月）
+
+```html
+<van-datetime-picker
+  v-model="currentDate"
+  type="year-month"
+  :min-date="minDate"
+/>
+```
+
+```js
+export default {
+  data() {
+    return {
+      currentDate: new Date()
+    };
+  }
+}
+```
+
+#### 选择时间
+
+```html
+<van-datetime-picker
+  v-model="currentDate"
+  type="time"
+  :min-hour="minHour"
+  :max-hour="maxHour"
+/>
+```
+
+```js
+export default {
+  data() {
+    return {
+      currentDate: '12:00'
+    };
+  }
+}
+```
+
+### API
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|-------------|
+| 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
+
+| 事件名称 | 说明 | 回调参数 |
+|-----------|-----------|-----------|
+| change | 当值变化时触发的事件 | picker 实例 |
+| confirm | 点击完成按钮时触发的事件 | 当前 value |
+| cancel | 点击取消按钮时触发的事件 | - |
+
+### change事件
+
+在`change`事件中，可以获取到`picker`实例，对`picker`进行相应的更新等操作：
+
+| 函数 | 说明 |
+|-----------|-----------|
+| getColumnValue(index) | 获取对应列中选中的值 |
+| setColumnValue(index, value) | 设置对应列中选中的值 |
+| getColumnValues(index) | 获取对应列中所有的备选值 |
+| setColumnValues(index, values) | 设置对应列中所有的备选值 |
+| getValues() | 获取所有列中被选中的值，返回一个数组 |
+| setValues(values) | `values`为一个数组，设置所有列中被选中的值 |