# DatePicker 日期选择器

用于选择或输入日期

# 选择日

以「日」为基本单位,基础的日期选择控件

  • 基本单位由pickerType属性指定。快捷选项需配置picker-options对象中的shortcuts,禁用日期通过 disabledDate 设置,传入函数

  • 默认会设置快捷选项picker-options,如果不需要请覆盖或者设置defaultOptionsfalse

不带快捷
默认带快捷选项
<template>
  <div class="demo-date-picker">
    <div class="block">
      <span class="demonstration">不带快捷</span>
      <higher-date-picker
        v-model="value1"
        pickerType="date"
        :defaultOptions="false"
        placeholder="选择日期">
      </higher-date-picker>
    </div>
    <div class="block">
      <span class="demonstration">默认带快捷选项</span>
      <higher-date-picker
        v-model="value2"
        align="right"
        pickerType="date"
        placeholder="选择日期">
      </higher-date-picker>
    </div>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        value1: '',
        value2: '',
      };
    }
  };
</script>
Expand Copy

# 其他日期单位

  • 通过扩展基础的日期选择,可以选择周、月、年或多个日期
多个日期
<template>
  <div class="demo-date-picker">
    <div class="container">
      <div class="block">
        <span class="demonstration"></span>
        <higher-date-picker
          v-model="value1"
          pickerType="week"
          format="yyyy 第 WW 周"
          placeholder="选择周">
        </higher-date-picker>
      </div>
      <div class="block">
        <span class="demonstration"></span>
        <higher-date-picker
          v-model="value2"
          pickerType="month"
          placeholder="选择月">
        </higher-date-picker>
      </div>
    </div>
    <div class="container">
      <div class="block">
        <span class="demonstration"></span>
        <higher-date-picker
          v-model="value3"
          pickerType="year"
          placeholder="选择年">
        </higher-date-picker>
      </div>
      <div class="block">
        <span class="demonstration">多个日期</span>
        <higher-date-picker
          pickerType="dates"
          v-model="value4"
          placeholder="选择一个或多个日期">
        </higher-date-picker>
      </div>
    </div>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        value1: '',
        value2: '',
        value3: '',
        value4: ''
      };
    }
  };
</script>
Expand Copy

# 选择日期范围

  • 可在一个选择器中便捷地选择一个时间范围
  • 在选择日期范围时,默认情况下左右面板会联动。如果希望两个面板各自独立切换当前月份,可以使用unlink-panels属性解除联动。
  • 于elm不同的是采用json形式,通过keys来设定.并且回显也使用这种格式
默认带快捷选项
<template>
  <div class="demo-date-picker">
    <div class="block">
      <span class="demonstration">默认带快捷选项</span>
      <higher-date-picker
        v-model="sendData"
        :options="options"
        pickerType='datetimerange'
      />
    </div>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        sendData: { "datePicker1": "2020-11-05", "datePicker2": "2020-12-24" },
        options: {
          keys: ['datePicker1', 'datePicker2'],
        }
      };
    }
  };
</script>
Expand Copy

# 选择月份范围

  • 可在一个选择器中便捷地选择一个月份范围
  • 在选择月份范围时,默认情况下左右面板会联动。如果希望两个面板各自独立切换当前年份,可以使用unlink-panels属性解除联动。
默认带快捷选项
<template>
  <div class="demo-date-picker">
    <div class="block">
      <span class="demonstration">默认带快捷选项</span>
      <higher-date-picker
        v-model="sendData"
        :options="options"
        pickerType='monthrange'
      />
    </div>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        sendData: { "datePicker1": "2020-11", "datePicker2": "2020-12" },
        options: {
          keys: ['datePicker1', 'datePicker2'],
        }
      };
    }
  };
</script>
Expand Copy

# 选择日期禁用

默认带快捷选项
<template>
  <div class="demo-date-picker">
    <div class="block">
      <span class="demonstration">默认带快捷选项</span>
      <higher-date-picker
        v-model="sendData"
        :options="options"
        pickerType='daterange'
        :pickerOptions="pickerOptions"
      />
    </div>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        sendData: { "datePicker1": "", "datePicker2": "" },
        options: {
          keys: ['datePicker1', 'datePicker2'],
        },
        pickerOptions: {
          disabledDate(time, instance) {
            const minDate = instance.minDate ? instance.minDate.getTime()
            : false
            const d = 24 * 60 * 60 * 1000 // 每天多少毫秒
            const y = (d * 30) * 1.5 // 设置一个半月
            return minDate && time - minDate > y
          }
        }
      };
    }
  };
</script>
Expand Copy

# Attributes

参数 说明 类型 可选值 默认值
value / v-model 绑定值 date(DatePicker) / array(DateRangePicker) / object
readonly 完全只读 boolean false
disabled 禁用 boolean false
editable 文本框可输入 boolean true
clearable 是否显示清除按钮 boolean true
size 输入框尺寸 string large, small, mini
placeholder 非范围选择时的占位内容 string
start-placeholder 范围选择时开始日期的占位内容 string
end-placeholder 范围选择时结束日期的占位内容 string
pickerType 显示类型 string year/month/date/dates/ week/datetime/datetimerange/ daterange/monthrange date
format 显示在输入框中的格式 string 日期格式 yyyy-MM-dd
align 对齐方式 string left, center, right left
popper-class DatePicker 下拉框的类名 string
picker-options 当前时间日期选择器特有的选项参考下表 object {}
range-separator 选择范围时的分隔符 string '-'
default-value 可选,选择器打开时默认显示的时间 Date 可被new Date()解析
default-time 范围选择时选中日期所使用的当日内具体时刻 string[] 数组,长度为 2,每项值为字符串,形如12:00:00,第一项指定开始日期的时刻,第二项指定结束日期的时刻,不指定会使用时刻 00:00:00
value-format 可选,绑定值的格式。不指定则绑定值为 Date 对象 string 日期格式
name 原生属性 string
unlink-panels 在范围选择器里取消两个日期面板之间的联动 boolean false
prefix-icon 自定义头部图标的类名 string el-icon-date
clear-icon 自定义清空图标的类名 string el-icon-circle-close
validate-event 输入时是否触发表单的校验 boolean - true

# Picker Options

参数 说明 类型 可选值 默认值
shortcuts 设置快捷选项,需要传入 { text, onClick } 对象用法参考 demo 或下表 Object[]
disabledDate 设置禁用状态,参数为当前日期,要求返回 Boolean Function
cellClassName 设置日期的 className Function(Date)
firstDayOfWeek 周起始日 Number 1 到 7 7
onPick 选中日期后会执行的回调,只有当 daterangedatetimerange 才生效 Function({ maxDate, minDate })

# Shortcuts

参数 说明 类型 可选值 默认值
text 标题文本 string
onClick 选中后的回调函数,参数是 vm,可通过触发 'pick' 事件设置选择器的值。例如 vm.$emit('pick', new Date()) function

# Events

事件名称 说明 回调参数
change 用户确认选定的值时触发 组件绑定值。格式与绑定值一致,可受 value-format 控制
blur 当 input 失去焦点时触发 组件实例
focus 当 input 获得焦点时触发 组件实例

# Methods

方法名 说明 参数
focus 使 input 获取焦点