[Doc] DatetimePicker: improve documentation (#747)

This commit is contained in:
neverland
2018-03-22 11:48:30 +08:00
committed by GitHub
parent 4810630215
commit 70fbdea35d
5 changed files with 123 additions and 38 deletions

View File

@@ -9,7 +9,7 @@ Vue.use(DatetimePicker);
### Usage
#### Basic Usage
#### Choose DateTime
```html
<van-datetime-picker
@@ -30,29 +30,57 @@ export default {
maxHour: 20,
minDate: new Date(),
maxDate: new Date(2019, 10, 1),
currentDate: new Date(2018, 0, 1)
currentDate: new Date()
};
}
};
```
#### Date Picker
#### Choose Date
```html
<van-datetime-picker
v-model="currentDate"
type="date"
:min-hour="minHour"
:max-hour="maxHour"
:min-date="minDate"
/>
```
#### Time Picker
```js
export default {
data() {
return {
currentDate: new Date()
};
}
}
```
#### Choose Year-Month
```html
<van-datetime-picker
v-model="currentDate3"
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"
@@ -60,11 +88,21 @@ export default {
/>
```
```js
export default {
data() {
return {
currentDate: '12:00'
};
}
}
```
### API
| Attribute | Description | Type | Default | Accepted Values |
|-----------|-----------|-----------|-------------|-------------|
| type | Picker type | `String` | 'datetime' | 'date', 'time' |
| 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` | - |

View File

@@ -9,7 +9,7 @@ Vue.use(DatetimePicker);
### 代码演示
#### 基础用法
#### 选择完整时间
```html
<van-datetime-picker
@@ -30,24 +30,52 @@ export default {
maxHour: 20,
minDate: new Date(),
maxDate: new Date(2019, 10, 1),
currentDate: new Date(2018, 0, 1)
currentDate: new Date()
};
}
};
```
#### 选择日期
#### 选择日期(年月日)
```html
<van-datetime-picker
v-model="currentDate"
type="date"
:min-hour="minHour"
:max-hour="maxHour"
: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
@@ -60,11 +88,21 @@ export default {
/>
```
```js
export default {
data() {
return {
currentDate: '12:00'
};
}
}
```
### API
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|-----------|-----------|-----------|-------------|-------------|
| type | 组件类型 | `String` | 'datetime' | 'date', 'time' |
| type | 组件类型 | `String` | `datetime` | `date` `time` `year-month` |
| min-date | 可选的最小日期 | `Date` | 十年前的 1 月 1 日 | - |
| max-date | 可选的最大日期 | `Date` | 十年后的 12 月 31 日 | - |
| min-hour | 可选的最小小时 | `Number` | `0` | - |