时间选择器,支持日期、年月、时分等维度,通常与 弹出层组件配合使用
import Vue from 'vue';
import { DatetimePicker } from 'vant';
Vue.use(DatetimePicker);
<van-datetime-picker
v-model="currentDate"
type="datetime"
:min-date="minDate"
:max-date="maxDate"
/>
export default {
data() {
return {
minDate: new Date(2020, 0, 1),
maxDate: new Date(2025, 10, 1),
currentDate: new Date()
};
}
};
<van-datetime-picker
v-model="currentDate"
type="date"
:min-date="minDate"
:max-date="maxDate"
/>
export default {
data() {
return {
minDate: new Date(2020, 0, 1),
maxDate: new Date(2025, 10, 1),
currentDate: new Date()
};
}
};
通过传入formatter函数,可以对选项文字进行格式化处理
<van-datetime-picker
v-model="currentDate"
type="year-month"
:min-date="minDate"
:max-date="maxDate"
:formatter="formatter"
/>
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;
}
}
}
<van-datetime-picker
v-model="currentTime"
type="time"
:min-hour="10"
:max-hour="20"
/>
export default {
data() {
return {
currentTime: '12:00'
};
}
};
通过传入filter函数,可以对选项数组进行过滤,实现自定义时间间隔
<van-datetime-picker
v-model="currentTime"
type="time"
:filter="filter"
/>
export default {
data() {
return {
currentTime: '12:00'
};
},
methods: {
filter(type, options) {
if (type === 'minute') {
return options.filter(option => option % 5 === 0);
}
return options;
}
}
};
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
type | 类型,可选值为 date 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 |
当时间选择器类型为 date 或 datetime 时,支持以下 props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
min-date | 可选的最小时间,精确到分钟 | Date | 十年前 |
max-date | 可选的最大时间,精确到分钟 | Date | 十年后 |
当时间选择器类型为 time 时,支持以下 props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
min-hour | 可选的最小小时 | number | string | 0 |
max-hour | 可选的最大小时 | number | string | 23 |
min-minute | 可选的最小分钟 | number | string | 0 |
max-minute | 可选的最大分钟 | number | string | 59 |
事件名 | 说明 | 回调参数 |
---|---|---|
change | 当值变化时触发的事件 | picker: Picker 实例 |
confirm | 点击完成按钮时触发的事件 | value: 当前选中的时间 |
cancel | 点击取消按钮时触发的事件 | - |
通过 ref 可以获取到 DatetimePicker 实例并调用实例方法,详见 组件实例方法
方法名 | 说明 | 参数 | 返回值 |
---|---|---|---|
getPicker v2.4.0 | 获取 Picker 实例,用于调用 Picker 的实例方法 | - | - |
请注意不要在模板中直接使用类似min-date="new Date()"的写法,这样会导致每次渲染组件时传入一个新的 Date 对象,而传入新的数据会触发下一次渲染,从而陷入死循环。
正确的做法是将min-date作为一个数据定义在data函数中。
如果你遇到了在 iOS 上无法渲染组件的问题,请确认在创建 Date 对象时没有使用new Date('2020-01-01')这样的写法,iOS 不支持以中划线分隔的日期格式,正确写法是new Date('2020/01/01')。
对此问题的详细解释:stackoverflow。
参见在桌面端使用。
如果仅需要选择年份或者月份,建议直接使用 Picker组件。