• DatePicker 日期选择器
    • 选择日
    • 其他日期单位
    • 选择日期范围
    • 选择月份范围
    • 日期格式
    • 默认显示日期
    • Attributes
    • Picker Options
    • Shortcuts
    • Events
    • Methods

    DatePicker 日期选择器

    用于选择或输入日期

    选择日

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

    DatePicker 日期选择器 - 图1

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

    1. <template>
    2. <div class="block">
    3. <span class="demonstration">默认</span>
    4. <el-date-picker
    5. v-model="value1"
    6. type="date"
    7. placeholder="选择日期">
    8. </el-date-picker>
    9. </div>
    10. <div class="block">
    11. <span class="demonstration">带快捷选项</span>
    12. <el-date-picker
    13. v-model="value2"
    14. align="right"
    15. type="date"
    16. placeholder="选择日期"
    17. :picker-options="pickerOptions">
    18. </el-date-picker>
    19. </div>
    20. </template>
    21. <script>
    22. export default {
    23. data() {
    24. return {
    25. pickerOptions: {
    26. disabledDate(time) {
    27. return time.getTime() > Date.now();
    28. },
    29. shortcuts: [{
    30. text: '今天',
    31. onClick(picker) {
    32. picker.$emit('pick', new Date());
    33. }
    34. }, {
    35. text: '昨天',
    36. onClick(picker) {
    37. const date = new Date();
    38. date.setTime(date.getTime() - 3600 * 1000 * 24);
    39. picker.$emit('pick', date);
    40. }
    41. }, {
    42. text: '一周前',
    43. onClick(picker) {
    44. const date = new Date();
    45. date.setTime(date.getTime() - 3600 * 1000 * 24 * 7);
    46. picker.$emit('pick', date);
    47. }
    48. }]
    49. },
    50. value1: '',
    51. value2: '',
    52. };
    53. }
    54. };
    55. </script>

    其他日期单位

    通过扩展基础的日期选择,可以选择周、月、年或多个日期

    DatePicker 日期选择器 - 图2

    <div class="container">
      <div class="block">
        <span class="demonstration">周</span>
        <el-date-picker
          v-model="value1"
          type="week"
          format="yyyy 第 WW 周"
          placeholder="选择周">
        </el-date-picker>
      </div>
      <div class="block">
        <span class="demonstration">月</span>
        <el-date-picker
          v-model="value2"
          type="month"
          placeholder="选择月">
        </el-date-picker>
      </div>
    </div>
    <div class="container">
      <div class="block">
        <span class="demonstration">年</span>
        <el-date-picker
          v-model="value3"
          type="year"
          placeholder="选择年">
        </el-date-picker>
      </div>
      <div class="block">
        <span class="demonstration">多个日期</span>
        <el-date-picker
          type="dates"
          v-model="value4"
          placeholder="选择一个或多个日期">
        </el-date-picker>
      </div>
    </div>
    
    <script>
      export default {
        data() {
          return {
            value1: '',
            value2: '',
            value3: '',
            value4: ''
          };
        }
      };
    </script>
    

    选择日期范围

    可在一个选择器中便捷地选择一个时间范围

    DatePicker 日期选择器 - 图3

    在选择日期范围时,默认情况下左右面板会联动。如果希望两个面板各自独立切换当前月份,可以使用unlink-panels属性解除联动。

    <template>
      <div class="block">
        <span class="demonstration">默认</span>
        <el-date-picker
          v-model="value1"
          type="daterange"
          range-separator="至"
          start-placeholder="开始日期"
          end-placeholder="结束日期">
        </el-date-picker>
      </div>
      <div class="block">
        <span class="demonstration">带快捷选项</span>
        <el-date-picker
          v-model="value2"
          type="daterange"
          align="right"
          unlink-panels
          range-separator="至"
          start-placeholder="开始日期"
          end-placeholder="结束日期"
          :picker-options="pickerOptions">
        </el-date-picker>
      </div>
    </template>
    
    <script>
      export default {
        data() {
          return {
            pickerOptions: {
              shortcuts: [{
                text: '最近一周',
                onClick(picker) {
                  const end = new Date();
                  const start = new Date();
                  start.setTime(start.getTime() - 3600 * 1000 * 24 * 7);
                  picker.$emit('pick', [start, end]);
                }
              }, {
                text: '最近一个月',
                onClick(picker) {
                  const end = new Date();
                  const start = new Date();
                  start.setTime(start.getTime() - 3600 * 1000 * 24 * 30);
                  picker.$emit('pick', [start, end]);
                }
              }, {
                text: '最近三个月',
                onClick(picker) {
                  const end = new Date();
                  const start = new Date();
                  start.setTime(start.getTime() - 3600 * 1000 * 24 * 90);
                  picker.$emit('pick', [start, end]);
                }
              }]
            },
            value1: '',
            value2: ''
          };
        }
      };
    </script>
    

    选择月份范围

    可在一个选择器中便捷地选择一个月份范围

    DatePicker 日期选择器 - 图4

    在选择月份范围时,默认情况下左右面板会联动。如果希望两个面板各自独立切换当前年份,可以使用unlink-panels属性解除联动。

    <template>
      <div class="block">
        <span class="demonstration">默认</span>
        <el-date-picker
          v-model="value1"
          type="monthrange"
          range-separator="至"
          start-placeholder="开始月份"
          end-placeholder="结束月份">
        </el-date-picker>
      </div>
      <div class="block">
        <span class="demonstration">带快捷选项</span>
        <el-date-picker
          v-model="value2"
          type="monthrange"
          align="right"
          unlink-panels
          range-separator="至"
          start-placeholder="开始月份"
          end-placeholder="结束月份"
          :picker-options="pickerOptions">
        </el-date-picker>
      </div>
    </template>
    
    <script>
      export default {
        data() {
          return {
            pickerOptions: {
              shortcuts: [{
                text: '本月',
                onClick(picker) {
                  picker.$emit('pick', [new Date(), new Date()]);
                }
              }, {
                text: '今年至今',
                onClick(picker) {
                  const end = new Date();
                  const start = new Date(new Date().getFullYear(), 0);
                  picker.$emit('pick', [start, end]);
                }
              }, {
                text: '最近六个月',
                onClick(picker) {
                  const end = new Date();
                  const start = new Date();
                  start.setMonth(start.getMonth() - 6);
                  picker.$emit('pick', [start, end]);
                }
              }]
            },
            value1: '',
            value2: ''
          };
        }
      };
    </script>
    

    日期格式

    使用format指定输入框的格式;使用value-format指定绑定值的格式。

    默认情况下,组件接受并返回Date对象。以下为可用的格式化字串,以 UTC 2017年1月2日 03:04:05 为例:

    请注意大小写

    格式含义备注举例
    yyyy2017
    M不补01
    MM01
    W仅周选择器的 format 可用;不补01
    WW仅周选择器的 format 可用01
    d不补02
    dd02
    H小时24小时制;不补03
    HH小时24小时制03
    h小时12小时制,须和 Aa 使用;不补03
    hh小时12小时制,须和 Aa 使用03
    m分钟不补04
    mm分钟04
    s不补05
    ss05
    AAM/PMformat 可用,大写AM
    aam/pmformat 可用,小写am
    timestampJS时间戳value-format 可用;组件绑定值为number类型1483326245000
    [MM]不需要格式化字符使用方括号标识不需要格式化的字符 (如 [A] [MM])MM

    DatePicker 日期选择器 - 图5

    <template>
      <div class="block">
        <span class="demonstration">默认为 Date 对象</span>
        <div class="demonstration">值:{{ value1 }}</div>
        <el-date-picker
          v-model="value1"
          type="date"
          placeholder="选择日期"
          format="yyyy 年 MM 月 dd 日">
        </el-date-picker>
      </div>
      <div class="block">
        <span class="demonstration">使用 value-format</span>
        <div class="demonstration">值:{{ value2 }}</div>
        <el-date-picker
          v-model="value2"
          type="date"
          placeholder="选择日期"
          format="yyyy 年 MM 月 dd 日"
          value-format="yyyy-MM-dd">
        </el-date-picker>
      </div>
      <div class="block">
        <span class="demonstration">时间戳</span>
        <div class="demonstration">值:{{ value3 }}</div>
        <el-date-picker
          v-model="value3"
          type="date"
          placeholder="选择日期"
          format="yyyy 年 MM 月 dd 日"
          value-format="timestamp">
        </el-date-picker>
      </div>
    </template>
    
    <script>
      export default {
        data() {
          return {
            value1: '',
            value2: '',
            value3: ''
          };
        }
      };
    </script>
    

    默认显示日期

    在选择日期范围时,指定起始日期和结束日期的默认时刻。

    DatePicker 日期选择器 - 图6

    选择日期范围时,默认情况下,起始日期和结束日期的时间部分均为当天的 0 点 0 分 0 秒。通过default-time可以分别指定二者的具体时刻。default-time接受一个数组,其中的值为形如12:00:00的字符串,第一个值控制起始日期的时刻,第二个值控制结束日期的时刻。

    <template>
      <div class="block">
        <p>组件值:{{ value }}</p>
        <el-date-picker
          v-model="value"
          type="daterange"
          start-placeholder="开始日期"
          end-placeholder="结束日期"
          :default-time="['00:00:00', '23:59:59']">
        </el-date-picker>
      </div>
    </template>
    
    <script>
      export default {
        data() {
          return {
            value: ''
          };
        }
      };
    </script>
    

    Attributes

    参数说明类型可选值默认值
    value / v-model绑定值date(DatePicker) / array(DateRangePicker)
    readonly完全只读booleanfalse
    disabled禁用booleanfalse
    editable文本框可输入booleantrue
    clearable是否显示清除按钮booleantrue
    size输入框尺寸stringlarge, small, mini
    placeholder非范围选择时的占位内容string
    start-placeholder范围选择时开始日期的占位内容string
    end-placeholder范围选择时结束日期的占位内容string
    type显示类型stringyear/month/date/dates/ week/datetime/datetimerange/ daterange/monthrangedate
    format显示在输入框中的格式string见日期格式yyyy-MM-dd
    align对齐方式stringleft, center, rightleft
    popper-classDatePicker 下拉框的类名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在范围选择器里取消两个日期面板之间的联动booleanfalse
    prefix-icon自定义头部图标的类名stringel-icon-date
    clear-icon自定义清空图标的类名stringel-icon-circle-close
    validate-event输入时是否触发表单的校验boolean-true

    Picker Options

    参数说明类型可选值默认值
    shortcuts设置快捷选项,需要传入 { text, onClick } 对象用法参考 demo 或下表Object[]
    disabledDate设置禁用状态,参数为当前日期,要求返回 BooleanFunction
    cellClassName设置日期的 classNameFunction(Date)
    firstDayOfWeek周起始日Number1 到 77
    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 获取焦点