介绍

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

引入

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;
    }
  }
};

API

Props

type类型,可选值为 date
time year-month
stringdatetime
title顶部栏标题string''
confirm-button-text确认按钮文字string确认
cancel-button-text取消按钮文字string取消
show-toolbar是否显示顶部栏booleantrue
loading是否显示加载状态booleanfalse
filter选项过滤函数(type, vals) => vals-
formatter选项格式化函数(type, val) => val-
item-height选项高度number | string44
visible-item-count可见的选项个数number | string5
swipe-duration v2.2.13快速滑动时惯性滚动的时长,单位msnumber | string1000

DatePicker Props

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

min-date可选的最小时间,精确到分钟Date十年前
max-date可选的最大时间,精确到分钟Date十年后

TimePicker Props

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

min-hour可选的最小小时number | string0
max-hour可选的最大小时number | string23
min-minute可选的最小分钟number | string0
max-minute可选的最大分钟number | string59

Events

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

方法

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

getPicker 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 组件。


实例演示

07-05 13:05