纷享销客开发者手册
目录

日期时间选择器

# FxDatePicker 日期时间选择器

移动端与PC端交互方式不同，故参数变动较多，移动端请直接参考底部移动端使用方式 在同一个选择器里选择日期和时间

:::tip DateTimePicker 由 DatePicker 和 TimePicker 派生，Picker Options 或者其他选项可以参照 DatePicker 和 TimePicker。 :::

# 日期和时间点

默认
带快捷选项
设置默认时间

通过设置type属性为datetime，即可在同一个选择器里同时进行日期和时间的选择。快捷选项的使用方法与 Date Picker 相同。

<template>
  <div class="block">
    <span class="demonstration">默认</span>
    <fx-date-picker
      v-model="value1"
      type="datetime"
      size="small"
      placeholder="选择日期时间">
    </fx-date-picker>
  </div>
  <div class="block">
    <span class="demonstration">带快捷选项</span>
    <fx-date-picker
      v-model="value2"
      type="datetime"
      placeholder="选择日期时间"
      align="right"
      :picker-options="pickerOptions">
    </fx-date-picker>
  </div>
  <div class="block">
    <span class="demonstration">设置默认时间</span>
    <fx-date-picker
      v-model="value3"
      type="datetime"
      placeholder="选择日期时间"
      default-time="12:00:00">
    </fx-date-picker>
  </div>
</template>

<script>
  export default {
    data() {
      return {
        pickerOptions: {
          shortcuts: [{
            text: '今天',
            backfillShortcutActive:true,
            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);
            }
          }]
        },
        value1: '',
        value2: '',
        value3: ''
      };
    }
  };
</script>
显示代码 复制代码

# 日期和时间范围

默认
带快捷选项

设置type为datetimerange即可选择日期和时间范围

<template>
  <div class="block">
    <span class="demonstration">默认</span>
    <fx-date-picker
      v-model="value1"
      type="datetimerange"
      :default-time="['','20:59:59']"
      range-separator="至"
      start-placeholder="开始日期"
      end-placeholder="结束日期">
    </fx-date-picker>
  </div>
  <div class="block">
    <span class="demonstration">带快捷选项</span>
    <fx-date-picker
      v-model="value2"
      type="datetimerange"
      :picker-options="pickerOptions"
      range-separator="至"
      start-placeholder="开始日期"
      end-placeholder="结束日期"
      align="right">
    </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: '最近一周',
            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: [new Date(2000, 10, 10, 10, 10), new Date(2000, 10, 11, 10, 10)],
        value2: ''
      };
    }
  };
</script>
显示代码 复制代码

# 默认的起始与结束时刻

起始日期时刻为 12:00:00
起始日期时刻为 12:00:00，结束日期时刻为 08:00:00

使用datetimerange进行范围选择时，在日期选择面板中选定起始与结束的日期，默认会使用该日期的00:00:00作为起始与结束的时刻；通过选项default-time可以控制选中起始与结束日期时所使用的具体时刻。default-time接受一个数组，数组每项值为字符串，形如12:00:00，其中第一项控制起始日期的具体时刻，第二项控制结束日期的具体时刻。

<template>
  <div class="block">
    <span class="demonstration">起始日期时刻为 12:00:00</span>
    <fx-date-picker
      v-model="value1"
      type="datetimerange"
      start-placeholder="开始日期"
      end-placeholder="结束日期"
      :default-time="['12:00:00']">
    </fx-date-picker>
  </div>
  <div class="block">
    <span class="demonstration">起始日期时刻为 12:00:00，结束日期时刻为 08:00:00</span>
    <fx-date-picker
      v-model="value2"
      type="datetimerange"
      align="right"
      start-placeholder="开始日期"
      end-placeholder="结束日期"
      :default-time="['12:00:00', '08:00:00']">
    </fx-date-picker>
  </div>
</template>

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

# Attributes

参数 说明 类型 可选值 默认值
value / v-model 绑定值 date(DateTimePicker) / array(DateTimeRangePicker) — —
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 — —
time-arrow-control 是否使用箭头进行时间选择 boolean — false
type 显示类型 string year/month/date/week/ datetime/datetimerange/daterange date
format 显示在输入框中的格式 string 见日期格式 yyyy-MM-dd HH:mm:ss
align 对齐方式 string left, center, right left
popper-class DateTimePicker 下拉框的类名 string — —
picker-options 当前时间日期选择器特有的选项参考下表 object — {}
range-separator 选择范围时的分隔符 string - '-'
default-value 可选，选择器打开时默认显示的时间 Date 可被new Date()解析 —
default-time 选中日期后的默认具体时刻 非范围选择时：string / 范围选择时：string[] 非范围选择时：形如12:00:00的字符串；范围选择时：数组，长度为 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

# Picker Options

参数 说明 类型 可选值 默认值
shortcuts 设置快捷选项，需要传入 { text, onClick } 对象用法参考 demo 或下表 Object[] — —
disabledDate 设置禁用状态，参数为当前日期，要求返回 Boolean Function — —
firstDayOfWeek 周起始日 Number 1 到 7 7

# Shortcuts

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

# Events

Event Name Description Parameters
change 用户确认选定的值时触发 组件绑定值。格式与绑定值一致，可受 value-format 控制
blur 当 input 失去焦点时触发 组件实例
focus 当 input 获得焦点时触发 组件实例
setShortcutHighlight 设置shortcut高亮 要高亮的shortcut的text

# Methods

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

# Slots

Name 说明
range-separator 自定义分隔符

# 移动端 时间选择器

支持`datetime 年月日时分格式。

# 使用指南
# 基础用法

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

<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
日期选择器
上传

← 上传→