# FxDatePicker 日期选择器

移动端与PC端交互方式不同,故参数变动较多,移动端请直接参考底部移动端使用方式

用于选择或输入日期

# 选择日

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

默认
带快捷选项

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

<template>
    <div class="block">
      <span class="demonstration">默认</span>
      <fx-date-picker
        v-model="value1"
        type="date"
        :default-value="defaultValue"
        placeholder="选择日期"
        @change="changeHandler">
      </fx-date-picker>
    </div>
    <div class="block">
      <span class="demonstration">带快捷选项</span>
      <fx-date-picker
        v-model="value2"
        align="right"
        type="date"
        size="small"
        placeholder="选择日期"
        :picker-options="pickerOptions">
      </fx-date-picker>
    </div>
</template>

<script>
  export default {
    data() {
      return {
        pickerOptions: {
          disabledDate(time) {
            return time.getTime() > Date.now();
          },
          shortcuts: [{
            text: '今天',
            backfillShortcut:true,
            onClick(picker) {
              picker.$emit('pickByShortcut', new Date(),this);
            }
          }, {
            text: '昨天',
            backfillShortcut:true,
            onClick(picker) {
              const date = new Date();
              date.setTime(date.getTime() - 3600 * 1000 * 24);
              picker.$emit('pickByShortcut', date,this);
            }
          }, {
            text: '一周前',
            backfillShortcut:true,
            onClick(picker) {
              const date = new Date();
              date.setTime(date.getTime() - 3600 * 1000 * 24 * 7);
              picker.$emit('pickByShortcut', date,this);
            }
          }]
        },
        defaultValue:'2019/6/5',
        value1: '',
        value2: '',
      };
    },
    methods:{
      changeHandler(val){
        console.log('changeHandler: ',val,this.value1);
      },
    }
  };
</script>
显示代码 复制代码

# 其他日期单位

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

多个日期
  <div class="container">
    <div class="block">
      <span class="demonstration"></span>
      <fx-date-picker
        v-model="value1"
        type="week"
        format="yyyy 第 WW 周"
        placeholder="选择周"
        @change="changeHandler">
      </fx-date-picker>
    </div>
    <div class="block">
      <span class="demonstration"></span>
      <fx-date-picker
        v-model="value2"
        type="month"
        placeholder="选择月"
        @change="changeHandler">
      </fx-date-picker>
    </div>
  </div>
  <div class="container">
    <div class="block">
      <span class="demonstration"></span>
      <fx-date-picker
        v-model="value3"
        type="year"
        placeholder="选择年"
        @change="changeHandler">
      </fx-date-picker>
    </div>
    <div class="block">
      <span class="demonstration">多个日期</span>
      <fx-date-picker
        type="dates"
        v-model="value4"
        placeholder="选择一个或多个日期"
        @change="changeHandler">
      </fx-date-picker>
    </div>
  </div>

<script>
  export default {
    data() {
      return {
        value1: '',
        value2: '',
        value3: '',
        value4: ''
      };
    },
    methods:{
      changeHandler(val){
        console.log('changeHandler: ',val,this.value1);
      },
    }
  };
</script>
显示代码 复制代码

# 选择日期范围

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

默认
带快捷选项

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

<template>
  <div class="block">
    <span class="demonstration">默认</span>
    <fx-date-picker
      v-model="value1"
      type="daterange"
      range-separator=""
      start-placeholder="开始日期"
      end-placeholder="结束日期"
        @change="changeHandler">
    </fx-date-picker>
  </div>
  <div class="block">
    <span class="demonstration">带快捷选项</span>
    <fx-date-picker
      v-model="value2"
      type="daterange"
      align="right"
      unlink-panels
      size="mini"
      range-separator=""
      start-placeholder="开始日期"
      end-placeholder="结束日期"
      :picker-options="pickerOptions"
      ref="demo3_2_datepicker"
      @change="changeHandler">
    </fx-date-picker>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        pickerOptions: {
          shortcuts:(function(){
            let list=[{
            text: '最近一周',
            backfillShortcutActive:true,
            backfillShortcut:true,
            onClick(picker) {
              const end = new Date();
              const start = new Date();
              start.setTime(start.getTime() - 3600 * 1000 * 24 * 7);
              picker.$emit('pickByShortcut', [start, end],this);
            }
          }, {
            text: '最近一个月',
            backfillShortcut:true,
            onClick(picker) {
              const end = new Date();
              const start = new Date();
              start.setTime(start.getTime() - 3600 * 1000 * 24 * 30);
              picker.$emit('pickByShortcut', [start, end],this);
            }
          }, {
            text: '最近三个月',
            backfillShortcut:true,
            onClick(picker) {
              const end = new Date();
              const start = new Date();
              start.setTime(start.getTime() - 3600 * 1000 * 24 * 90);
              picker.$emit('pickByShortcut', [start, end],this);
            }
          }]
            for(let i=0;i<15;i++){
              list.push({
                text: '第'+(i+1)+'天',
                backfillShortcut:true,
                onClick(picker){
                  picker.$emit('pickByShortcut',[],this)
                }
              })
            }
            return list;
          })(),
          shortcuts1: [{
            text: '最近一周',
            backfillShortcutActive:true,
            backfillShortcut:true,
            onClick(picker) {
              const end = new Date();
              const start = new Date();
              start.setTime(start.getTime() - 3600 * 1000 * 24 * 7);
              picker.$emit('pickByShortcut', [start, end],this);
            }
          }, {
            text: '最近一个月',
            backfillShortcut:true,
            onClick(picker) {
              const end = new Date();
              const start = new Date();
              start.setTime(start.getTime() - 3600 * 1000 * 24 * 30);
              picker.$emit('pickByShortcut', [start, end],this);
            }
          }, {
            text: '最近三个月',
            backfillShortcut:true,
            onClick(picker) {
              const end = new Date();
              const start = new Date();
              start.setTime(start.getTime() - 3600 * 1000 * 24 * 90);
              picker.$emit('pickByShortcut', [start, end],this);
            }
          }]
        },
        value1: '',
        value2: ''
      };
    },
    methods:{
      changeHandler(val){
        console.log('changeHandler2: ',val);
        // this.$refs.demo3_2_datepicker.setShortcutHighlight('最近三个月');

      }
    }
  };
</script>
显示代码 复制代码

# 选择月份范围

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

默认
带快捷选项

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

<template>
  <div class="block">
    <span class="demonstration">默认</span>
    <fx-date-picker
      v-model="value1"
      type="monthrange"
      range-separator=""
      start-placeholder="开始月份"
      end-placeholder="结束月份"
      @change="changeHandler">
    </fx-date-picker>
  </div>
  <div class="block">
    <span class="demonstration">带快捷选项</span>
    <fx-date-picker
      v-model="value2"
      type="monthrange"
      align="right"
      unlink-panels
      size="small"
      range-separator=""
      start-placeholder="开始月份"
      end-placeholder="结束月份"
      :picker-options="pickerOptions">
    </fx-date-picker>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        pickerOptions: {
          shortcuts: [{
            text: '本月',
            backfillShortcut:true,
            onClick(picker) {
              picker.$emit('pickByShortcut', [new Date(), new Date()],this);
            }
          }, {
            text: '今年至今',
            onClick(picker) {
              const end = new Date();
              const start = new Date(new Date().getFullYear(), 0);
              picker.$emit('pickByShortcut', [start, end],this);
            }
          }, {
            text: '最近六个月',
            onClick(picker) {
              const end = new Date();
              const start = new Date();
              start.setMonth(start.getMonth() - 6);
              picker.$emit('pickByShortcut', [start, end],this);
            }
          }]
        },
        value1: '',
        value2: ''
      };
    },
    methods:{
      changeHandler(val){
        console.log('changeHandler: ',val,this.value1);
      }
    }
  };
</script>
显示代码 复制代码

# 日期格式

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

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

WARNING

请注意大小写

格式 含义 备注 举例
yyyy 2017
M 不补0 1
MM 01
W 仅周选择器的 format 可用;不补0 1
WW 仅周选择器的 format 可用 01
d 不补0 2
dd 02
H 小时 24小时制;不补0 3
HH 小时 24小时制 03
h 小时 12小时制,须和 Aa 使用;不补0 3
hh 小时 12小时制,须和 Aa 使用 03
m 分钟 不补0 4
mm 分钟 04
s 不补0 5
ss 05
A AM/PM format 可用,大写 AM
a am/pm format 可用,小写 am
timestamp JS时间戳 value-format 可用;组件绑定值为number类型 1483326245000
默认为 Date 对象
值:
使用 value-format
值:
时间戳
值:
<template>
  <div class="block">
    <span class="demonstration">默认为 Date 对象</span>
    <div class="demonstration">值:{{value1 }}</div>
    <fx-date-picker
      v-model="value1"
      type="date"
      placeholder="选择日期"
      format="yyyy 年 MM 月 dd 日">
    </fx-date-picker>
  </div>
  <div class="block">
    <span class="demonstration">使用 value-format</span>
    <div class="demonstration">值:{{ value2 }}</div>
    <fx-date-picker
      v-model="value2"
      type="date"
      placeholder="选择日期"
      format="yyyy 年 MM 月 dd 日"
      value-format="yyyy-MM-dd">
    </fx-date-picker>
  </div>
  <div class="block">
    <span class="demonstration">时间戳</span>
    <div class="demonstration">值:{{ value3 }}</div>
    <fx-date-picker
      v-model="value3"
      type="date"
      placeholder="选择日期"
      format="yyyy 年 MM 月 dd 日"
      value-format="timestamp">
    </fx-date-picker>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        value1: '',
        value2: '',
        value3: ''
      };
    }
  };
</script>
显示代码 复制代码

# 默认显示日期

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

组件值:

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

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

<script>
  export default {
    data() {
      return {
        value: ''
      };
    }
  };
</script>
显示代码 复制代码

# Attributes

参数 说明 类型 可选值 默认值
value / v-model 绑定值 date(DatePicker) / array(DateRangePicker)
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
type 显示类型 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
firstDayOfWeek 周起始日 Number 1 到 7 7
onPick 选中日期后会执行的回调,只有当 daterangedatetimerange 才生效 Function({ maxDate, minDate })

# Shortcuts

参数 说明 类型 可选值 默认值
text 标题文本 string
backfillShortcutActive 设置当前shortcut是否默认选中 boolean
backfillShortcut 设置是否回填当前shortcut的text值 boolean
onClick 选中后的回调函数,参数是 vm,可通过触发 'pick' 事件设置选择器的值。例如 vm.$emit('pickByShortcut', new Date(),this),参数中的this为当前shortcat对象 function

# Events

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

# Methods

方法名 说明 参数
focus 使 input 获取焦点
setShortcutHighlight 设置shortcut高亮 要高亮的shortcut的text

# 移动端 时间选择器

支持 date 年月日

# 使用指南
# 基础用法

visible参数挂上.sync语法糖后,组件会自主控制弹层的显示关闭,而不需要在cancelconfirm事件中控制。

<template>
  <fx-date-picker
    :visible.sync="show"
    v-model="value"
  ></fx-date-picker>
</template>

<script>
export default {
  data() {
    return {
      show: false,
      value: new Date(),
    }
  }
}
</script>
# 自定义选项格式

和大部分的date format函数原理类似,正则捕获对应的日期占位符然后把紧接着的字符串抽出来展示,对value值没有影响。

<template>
  <fx-date-picker
    :visible.sync="show"
    v-model="value"
    format="yyyy,MM,dd,hh时,mm分"
  ></fx-date-picker>
</template>

<script>
export default {
  data() {
    return {
      show: false,
      value: new Date(),
    }
  }
}
</script>
# 单向数据流

其他picker没有支持单向数据流,建议使用方自己wrap一层来实现。

设置:value-binding="false"可以取消v-model的数据双向绑定(允许不传v-model),可以满足只监听confirm事件的场景。

# API
option description type acceptable values default
visible 控制展示关闭 Boolean false
v-model 选中值 Date|String --
min-date 日期可选最小值 Date 十年前的1月1日
max-date 日期可选最大值 Date 十年后的12月31日
min-hour 小时可选最小值 Number 0
max-hour 小时可选最大值 Number 23
format 展示格式,逗号分隔 String yyyy年,MM月,dd日,hh,mm
item-height 选项高度,单位为px Number 36
visible-item-count 同时可见item的数量 Number 7
value-binding 是否启用value的双向绑定,倘若为false,可以实现v-model单向传递 Boolean true
cancel-btn-text 取消按钮的文案 String 取消
confirm-btn-text 确定按钮的文案 String 确定
class-name 弹出层的根节点class String --
# Events
event description params
cancel 点击取消 --
confirm 点击确定 value
update:visible 弹层开启关闭时触发 visible
# API

除了包含Datetime Picker的API之外,还有以下列出的:

option description type acceptable values default
show-toolbar 是否展示头部操作栏 Boolean true
prevent-click 由于点击项时选中的pageY是以picker固定定位在底部为基准的,若picker位置不在页面底部,请关闭click事件 Boolean false
lastUpdate: 5/3/2023, 11:40:26 PM