Calendar 日历

介绍

日历组件用于选择日期或日期区间,2.4 版本开始支持此组件

引入

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

代码演示

选择单个日期

下面演示了结合单元格来使用日历组件的用法,日期选择完成后会触发confirm事件

  1. <van-cell title="选择单个日期" :value="date" @click="show = true" />
  2. <van-calendar v-model="show" @confirm="onConfirm" />
  1. export default {
  2. data() {
  3. return {
  4. date: '',
  5. show: false
  6. };
  7. },
  8. methods: {
  9. formatDate(date) {
  10. return `${date.getMonth() + 1}/${date.getDate()}`;
  11. },
  12. onConfirm(date) {
  13. this.show = false;
  14. this.date = this.formatDate(date);
  15. }
  16. }
  17. };

选择日期区间

设置typerange后可以选择日期区间,此时confirm事件返回的 date 为数组结构,数组第一项为开始时间,第二项为结束时间。

  1. <van-cell title="选择日期区间" :value="date" @click="show = true" />
  2. <van-calendar v-model="show" type="range" @confirm="onConfirm" />
  1. export default {
  2. data() {
  3. return {
  4. date: '',
  5. show: false
  6. };
  7. },
  8. methods: {
  9. formatDate(date) {
  10. return `${date.getMonth() + 1}/${date.getDate()}`;
  11. },
  12. onConfirm(date) {
  13. const [start, end] = date;
  14. this.show = false;
  15. this.date = `${this.formatDate(start)} - ${this.formatDate(end)}`;
  16. }
  17. }
  18. };

快捷选择

show-confirm设置为false可以隐藏确认按钮,这种情况下选择完成后会立即触发confirm事件

  1. <van-calendar v-model="show" :show-confirm="false" />

自定义颜色

通过color属性可以自定义日历的颜色,对选中日期和底部按钮生效

<van-calendar v-model="show" color="#07c160" />

自定义日期范围

通过min-datemax-date定义日历的范围

<van-calendar
  v-model="show"
  :min-date="minDate"
  :max-date="maxDate"
/>
export default {
  data() {
    return {
      show: false,
      minDate: new Date(2010, 0, 1),
      maxDate: new Date(2010, 0, 31)
    };
  }
};

自定义按钮文字

通过confirm-text设置按钮文字,通过confirm-disabled-text设置按钮禁用时的文字

<van-calendar
  v-model="show"
  type="range"
  confirm-text="完成"
  confirm-disabled-text="请选择结束时间"
/>

自定义日期文案

通过传入formatter函数来对日历上每一格的内容进行格式化

<van-calendar
  v-model="show"
  type="range"
  :formatter="formatter"
/>
export default {
  methods: {
    formatter(day) {
      const month = day.date.getMonth() + 1;
      const date = day.date.getDate();

      if (month === 5) {
        if (date === 1) {
          day.topInfo = '劳动节';
        } else if (date === 4) {
          day.topInfo = '五四青年节';
        } else if (date === 11) {
          day.text = '今天';
        }
      }

      if (day.type === 'start') {
        day.bottomInfo = '入住';
      } else if (day.type === 'end') {
        day.bottomInfo = '离店';
      }

      return day;
    }
  }
}

自定义弹出位置

通过position属性自定义弹出层的弹出位置,可选值为topleftright

<van-calendar
  v-model="show"
  :round="false"
  position="right"
/>

日期区间最大范围

选择日期区间时,可以通过max-range属性来指定最多可选天数,选择的范围超过最多可选天数时,会弹出相应的提示文案

<van-calendar
  type="range"
  :max-range="3"
  :style="{ height: '500px' }"
/>

平铺展示

poppable设置为false,日历会直接展示在页面内,而不是以弹层的形式出现

<van-calendar
  title="日历"
  :poppable="false"
  :show-confirm="false"
  :style="{ height: '500px' }"
/>

API

Props

参数说明类型默认值
v-model是否显示日历弹窗booleanfalse
type选择类型,single表示选择单个日期,range表示选择日期区间stringsingle
title日历标题string日期选择
color颜色,对底部按钮和选中日期生效string#ee0a24
min-date最小日期Date当前日期
max-date最大日期Date当前日期的六个月后
default-date默认选中的日期Date | Date[]今天
row-height日期行高number64
formatter日期格式化函数(day: Day) => Day-
position弹出位置,可选值为 top right leftstringbottom
poppable是否以弹层的形式展示日历booleantrue
round是否显示圆角弹窗booleantrue
show-mark是否显示月份背景水印booleantrue
show-confirm是否展示确认按钮booleantrue
close-on-click-overlay是否在点击遮罩层后关闭booleantrue
safe-area-inset-bottom是否开启底部安全区适配,详细说明booleantrue
confirm-text确认按钮的文字string确定
confirm-disabled-text确认按钮处于禁用状态时的文字string确定
max-range2.4.3日期区间最多可选天数,默认无限制number-
range-prompt2.4.3选择超过区间范围时的提示文案string选择天数不能超过 xx 天

Day 数据结构

日历中的每个日期都对应一个 Day 对象,通过formatter属性可以自定义 Day 对象的内容

键名说明类型
date日期对应的 Date 对象Date
type日期类型,可选值为selectedstartmiddleenddisabledstring
text中间显示的文字string
topInfo上方的提示信息string
bottomInfo下方的提示信息string
className额外类名string

Events

事件名说明回调参数
select点击任意日期时触发value: Date | Date[]
confirm日期选择完成后触发,若show-confirmtrue,则点击确认按钮后触发value: Date | Date[]

Slots

名称说明
title自定义标题
footer自定义底部区域内容

方法

通过 ref 可以获取到 Calendar 实例并调用实例方法

方法名说明参数返回值
reset重置选中的日期到默认值--

常见问题

在 iOS 系统上初始化组件失败?

如果你遇到了在 iOS 上无法渲染组件的问题,请确认在创建 Date 对象时没有使用new Date('2020-01-01')这样的写法,iOS 不支持以中划线分隔的日期格式,正确写法是new Date('2020/01/01')

对此问题的详细解释:stackoverflow

Calendar 日历 - 图1