-

介绍

时间选择器,支持日期、年月、时分等维度,通常与 弹出层 组件配合使用

引入

  1. import Vue from 'vue';
  2. import { DatetimePicker } from 'vant';
  3. Vue.use(DatetimePicker);

代码演示

选择完整时间

  1. <van-datetime-picker
  2. v-model="currentDate"
  3. type="datetime"
  4. :min-date="minDate"
  5. :max-date="maxDate"
  6. />
  1. export default {
  2. data() {
  3. return {
  4. minDate: new Date(2020, 0, 1),
  5. maxDate: new Date(2025, 10, 1),
  6. currentDate: new Date()
  7. };
  8. }
  9. };

选择日期(年月日)

  1. <van-datetime-picker
  2. v-model="currentDate"
  3. type="date"
  4. :min-date="minDate"
  5. :max-date="maxDate"
  6. />
  1. export default {
  2. data() {
  3. return {
  4. minDate: new Date(2020, 0, 1),
  5. maxDate: new Date(2025, 10, 1),
  6. currentDate: new Date()
  7. };
  8. }
  9. };

选择日期(年月)

通过传入formatter函数,可以对选项文字进行格式化处理

  1. <van-datetime-picker
  2. v-model="currentDate"
  3. type="year-month"
  4. :min-date="minDate"
  5. :max-date="maxDate"
  6. :formatter="formatter"
  7. />
  1. export default {
  2. data() {
  3. return {
  4. minDate: new Date(2020, 0, 1),
  5. maxDate: new Date(2025, 10, 1),
  6. currentDate: new Date()
  7. };
  8. },
  9. methods: {
  10. formatter(type, val) {
  11. if (type === 'year') {
  12. return `${val}年`;
  13. } else if (type === 'month') {
  14. return `${val}月`
  15. }
  16. return val;
  17. }
  18. }
  19. }

选择时间

  1. <van-datetime-picker
  2. v-model="currentTime"
  3. type="time"
  4. :min-hour="10"
  5. :max-hour="20"
  6. />
  1. export default {
  2. data() {
  3. return {
  4. currentTime: '12:00'
  5. };
  6. }
  7. };

选项过滤器

通过传入filter函数,可以对选项数组进行过滤,实现自定义时间间隔

  1. <van-datetime-picker
  2. v-model="currentTime"
  3. type="time"
  4. :filter="filter"
  5. />
  1. export default {
  2. data() {
  3. return {
  4. currentTime: '12:00'
  5. };
  6. },
  7. methods: {
  8. filter(type, options) {
  9. if (type === 'minute') {
  10. return options.filter(option => option % 5 === 0);
  11. }
  12. return options;
  13. }
  14. }
  15. };

API

Props

参数说明类型默认值
type类型,可选值为 
  1. date

  1. time
 
  1. year-month
string
  1. datetime
title顶部栏标题string
  1. ''
confirm-button-text确认按钮文字string
  1. 确认
cancel-button-text取消按钮文字string
  1. 取消
show-toolbar是否显示顶部栏boolean
  1. true
loading是否显示加载状态boolean
  1. false
filter选项过滤函数(type, vals) => vals-
formatter选项格式化函数(type, val) => val-
item-height选项高度number | string
  1. 44
visible-item-count可见的选项个数number | string
  1. 5
swipe-duration 
  1. v2.2.13
快速滑动时惯性滚动的时长,单位
  1. ms
number | string
  1. 1000

DatePicker Props

当时间选择器类型为 date 或 datetime 时,支持以下 props

参数说明类型默认值
min-date可选的最小时间,精确到分钟Date十年前
max-date可选的最大时间,精确到分钟Date十年后

TimePicker Props

当时间选择器类型为 time 时,支持以下 props

参数说明类型默认值
min-hour可选的最小小时number | string
  1. 0
max-hour可选的最大小时number | string
  1. 23
min-minute可选的最小分钟number | string
  1. 0
max-minute可选的最大分钟number | string
  1. 59

Events

事件名说明回调参数
change当值变化时触发的事件picker: Picker 实例
confirm点击完成按钮时触发的事件value: 当前选中的时间
cancel点击取消按钮时触发的事件-

方法

通过 ref 可以获取到 DatetimePicker 实例并调用实例方法,详见 组件实例方法

方法名说明参数返回值
getPicker 
  1. v2.4.0
获取 Picker 实例,用于调用 Picker 的实例方法--

常见问题

设置 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

在桌面端无法操作组件?

参见在桌面端使用

是否有年份或月份选择器?

如果仅需要选择年份或者月份,建议直接使用 Picker 组件。


实例演示