mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-09-23 11:29:56 +08:00
227 lines
5.7 KiB
Markdown
227 lines
5.7 KiB
Markdown
# DatetimePicker 时间选择
|
||
|
||
### 介绍
|
||
|
||
时间选择器，支持日期、年月、时分等维度，通常与[弹出层](#/zh-CN/popup)组件配合使用
|
||
|
||
### 引入
|
||
|
||
```js
|
||
import Vue from 'vue';
|
||
import { DatetimePicker } from 'vant';
|
||
|
||
Vue.use(DatetimePicker);
|
||
```
|
||
|
||
## 代码演示
|
||
|
||
### 选择年月日
|
||
|
||
```html
|
||
<van-datetime-picker
|
||
v-model="currentDate"
|
||
type="date"
|
||
title="选择年月日"
|
||
:min-date="minDate"
|
||
:max-date="maxDate"
|
||
/>
|
||
```
|
||
|
||
```js
|
||
export default {
|
||
data() {
|
||
return {
|
||
minDate: new Date(2020, 0, 1),
|
||
maxDate: new Date(2025, 10, 1),
|
||
currentDate: new Date(),
|
||
};
|
||
},
|
||
};
|
||
```
|
||
|
||
### 选择年月
|
||
|
||
通过传入`formatter`函数，可以对选项文字进行格式化处理
|
||
|
||
```html
|
||
<van-datetime-picker
|
||
v-model="currentDate"
|
||
type="year-month"
|
||
title="选择年月"
|
||
:min-date="minDate"
|
||
:max-date="maxDate"
|
||
:formatter="formatter"
|
||
/>
|
||
```
|
||
|
||
```js
|
||
export default {
|
||
data() {
|
||
return {
|
||
minDate: new Date(2020, 0, 1),
|
||
maxDate: new Date(2025, 10, 1),
|
||
currentDate: new Date(),
|
||
};
|
||
},
|
||
methods: {
|
||
formatter(type, val) {
|
||
if (type === 'year') {
|
||
return `${val}年`;
|
||
} else if (type === 'month') {
|
||
return `${val}月`;
|
||
}
|
||
return val;
|
||
},
|
||
},
|
||
};
|
||
```
|
||
|
||
### 选择时间
|
||
|
||
```html
|
||
<van-datetime-picker
|
||
v-model="currentTime"
|
||
type="time"
|
||
title="选择时间"
|
||
:min-hour="10"
|
||
:max-hour="20"
|
||
/>
|
||
```
|
||
|
||
```js
|
||
export default {
|
||
data() {
|
||
return {
|
||
currentTime: '12:00',
|
||
};
|
||
},
|
||
};
|
||
```
|
||
|
||
### 选择完整时间
|
||
|
||
```html
|
||
<van-datetime-picker
|
||
v-model="currentDate"
|
||
type="datetime"
|
||
title="选择完整时间"
|
||
:min-date="minDate"
|
||
:max-date="maxDate"
|
||
/>
|
||
```
|
||
|
||
```js
|
||
export default {
|
||
data() {
|
||
return {
|
||
minDate: new Date(2020, 0, 1),
|
||
maxDate: new Date(2025, 10, 1),
|
||
currentDate: new Date(),
|
||
};
|
||
},
|
||
};
|
||
```
|
||
|
||
### 选项过滤器
|
||
|
||
通过传入`filter`函数，可以对选项数组进行过滤，实现自定义时间间隔
|
||
|
||
```html
|
||
<van-datetime-picker v-model="currentTime" type="time" :filter="filter" />
|
||
```
|
||
|
||
```js
|
||
export default {
|
||
data() {
|
||
return {
|
||
currentTime: '12:00',
|
||
};
|
||
},
|
||
methods: {
|
||
filter(type, options) {
|
||
if (type === 'minute') {
|
||
return options.filter((option) => option % 5 === 0);
|
||
}
|
||
|
||
return options;
|
||
},
|
||
},
|
||
};
|
||
```
|
||
|
||
## API
|
||
|
||
### Props
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 |
|
||
| --- | --- | --- | --- |
|
||
| type | 类型，可选值为 `date` <br> `time` `year-month` | _string_ | `datetime` |
|
||
| title | 顶部栏标题 | _string_ | `''` |
|
||
| confirm-button-text | 确认按钮文字 | _string_ | `确认` |
|
||
| cancel-button-text | 取消按钮文字 | _string_ | `取消` |
|
||
| show-toolbar | 是否显示顶部栏 | _boolean_ | `true` |
|
||
| loading | 是否显示加载状态 | _boolean_ | `false` |
|
||
| filter | 选项过滤函数 | _(type, vals) => vals_ | - |
|
||
| formatter | 选项格式化函数 | _(type, val) => val_ | - |
|
||
| item-height | 选项高度 | _number \| string_ | `44` |
|
||
| visible-item-count | 可见的选项个数 | _number \| string_ | `5` |
|
||
| swipe-duration `v2.2.13` | 快速滑动时惯性滚动的时长，单位`ms` | _number \| string_ | `1000` |
|
||
|
||
### DatePicker Props
|
||
|
||
当时间选择器类型为 date 或 datetime 时，支持以下 props:
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 |
|
||
| -------- | -------------------------- | ------ | ------ |
|
||
| min-date | 可选的最小时间，精确到分钟 | _Date_ | 十年前 |
|
||
| max-date | 可选的最大时间，精确到分钟 | _Date_ | 十年后 |
|
||
|
||
### TimePicker Props
|
||
|
||
当时间选择器类型为 time 时，支持以下 props:
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 |
|
||
| ---------- | -------------- | ------------------ | ------ |
|
||
| min-hour | 可选的最小小时 | _number \| string_ | `0` |
|
||
| max-hour | 可选的最大小时 | _number \| string_ | `23` |
|
||
| min-minute | 可选的最小分钟 | _number \| string_ | `0` |
|
||
| max-minute | 可选的最大分钟 | _number \| string_ | `59` |
|
||
|
||
### Events
|
||
|
||
| 事件名 | 说明 | 回调参数 |
|
||
| ------- | ------------------------ | --------------------- |
|
||
| change | 当值变化时触发的事件 | picker: Picker 实例 |
|
||
| confirm | 点击完成按钮时触发的事件 | value: 当前选中的时间 |
|
||
| cancel | 点击取消按钮时触发的事件 | - |
|
||
|
||
### 方法
|
||
|
||
通过 ref 可以获取到 DatetimePicker 实例并调用实例方法，详见[组件实例方法](#/zh-CN/quickstart#zu-jian-shi-li-fang-fa)
|
||
|
||
| 方法名 | 说明 | 参数 | 返回值 |
|
||
| --- | --- | --- | --- |
|
||
| getPicker `v2.5.3` | 获取 Picker 实例，用于调用 Picker 的[实例方法](#/zh-CN/picker#fang-fa) | - | - |
|
||
|
||
## 常见问题
|
||
|
||
### 设置 min-date 或 max-date 后出现页面卡死的情况？
|
||
|
||
请注意不要在模板中直接使用类似`min-date="new Date()"`的写法，这样会导致每次渲染组件时传入一个新的 Date 对象，而传入新的数据会触发下一次渲染，从而陷入死循环。
|
||
|
||
正确的做法是将`min-date`作为一个数据定义在`data`函数中。
|
||
|
||
### 在 iOS 系统上初始化组件失败？
|
||
|
||
如果你遇到了在 iOS 上无法渲染组件的问题，请确认在创建 Date 对象时没有使用`new Date('2020-01-01')`这样的写法，iOS 不支持以中划线分隔的日期格式，正确写法是`new Date('2020/01/01')`。
|
||
|
||
对此问题的详细解释：[stackoverflow](https://stackoverflow.com/questions/13363673/javascript-date-is-invalid-on-ios)。
|
||
|
||
### 在桌面端无法操作组件？
|
||
|
||
参见[在桌面端使用](#/zh-CN/quickstart#zai-zhuo-mian-duan-shi-yong)。
|
||
|
||
### 是否有年份或月份选择器？
|
||
|
||
如果仅需要选择年份或者月份，建议直接使用 [Picker](#/zh-CN/picker) 组件。
|