Skip to content

DateTimePicker 日期时间选择器

使用
import { KDateTimePicker } from "@ksware/ksw-ux";

在同一个选择器里选择日期和时间

TIP

日期时间选择器来自日期选择器和时间选择器的组合。 关于属性的更详细解释,请参阅日期选择器和时间选择器。

日期和时间点

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

日期时间格式

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

默认情况下,组件接受并返回Date对象。

这里 查看 Day.js 支持的所有格式。

WARNING

请一定要注意传入参数的大小写是否正确

下拉列表中的日期和时间格式

使用 date-formattime-format 控制下拉列表面板输入框中显示的文本格式

日期和时间范围

设置typedatetimerange即可选择日期和时间范围

默认的起始与结束时刻

使用datetimerange进行范围选择时,在日期选择面板中选定起始与结束的日期,默认会使用该日期的00:00:00作为起始与结束的时刻;通过选项default-time可以控制选中起始与结束日期时所使用的具体时刻。 我们可以使用 default-time 属性来控制它。 default-time接受一个数组,其中第一项控制起始日期的具体时刻,第二项控制结束日期的具体时刻。 第一项控制开始日期的时间值,第二项控制结束日期的时间值。

自定义图标

使用插槽自定义图标。

API

Props

参数名描述类型默认值
model-value / v-model绑定值,如果它是数组,长度应该是 2Date / number / string / Array-
readonly只读booleanfalse
disabled禁用booleanfalse
editable文本框可输入booleantrue
clearable是否显示清除按钮booleantrue
show-default-shortcuts是否显示默认快捷日期booleantrue
size输入框尺寸enum'base'
placeholder非范围选择时的占位内容string-
start-placeholder范围选择时开始日期的占位内容string-
end-placeholder范围选择时结束日期的占位内容string-
arrow-control是否使用箭头进行时间选择booleanfalse
type显示类型string'date'
format显示在输入框中的格式string'YYYY-MM-DD HH:mm:ss'
popper-classDateTimePicker 下拉框的类名string-
range-separator选择范围时的分隔符string-
default-value可选,选择器打开时默认显示的时间Date / [Date, Date]-
default-time选择日期后的默认时间值。如未指定则默认时间值为 00:00:00Date / [Date, Date]-
value-format可选,绑定值的格式。不指定则绑定值为 Date 对象string-
date-format可选,时间选择器下拉列表中显示的日期格式string-
time-format可选,时间选择器下拉列表中显示的时间格式string-
id等价于原生 input id 属性string / [string, string]-
name等价于原生 input name 属性string-
unlink-panels在范围选择器里取消两个日期面板之间的联动booleanfalse
prefix-icon自定义前缀图标组件string | Component-
clear-icon自定义清除图标string | Component-
shortcuts设置快捷选项,需要传入数组对象object[{ text: string, value: date / function }]-
disabled-date一个用来判断该日期是否被禁用的函数,接受一个 Date 对象作为参数。应该返回一个 Boolean 值。Function(Date)-
cell-class-name设置自定义类名Function(Date)-
teleported是否将 datetime-picker 的下拉列表插入至 body 元素booleantrue

Events

事件名描述类型
change用户确认选定的值时触发Function
blur在组件 Input 失去焦点时触发Function
focus在组件 Input 获得焦点时触发Function
clear可清空的模式下用户点击清空按钮时触发Function
calendar-change如果用户没有选择日期,那默认展示当前日的月份。 仅用于 rangeFunction
panel-change当日期面板改变时触发Function
visible-change当 DateTimePicker 的下拉列表出现/消失时触发Function

Slots

插槽名描述参数
default自定义单元格内容-
range-separator自定义范围分割符内容-
prev-month上个月的图标-
next-month下个月的图标-
prev-year上一年的图标-
next-year下一年的图标-

Methods

方法名描述类型
focus使 input 获取焦点Function
blur使 input 失去焦点Function