Skip to content

DateTimePicker 日期时间选择器

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

TIP

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

日期和时间点

日期时间格式

日期和时间范围

默认的起始与结束时刻

API

Props

参数说明类型可选值默认值
model-value / v-model绑定值,如果它是数组,长度应该是 2enum--
readonly只读boolean-false
disabled禁用boolean-false
size输入框尺寸stringenumdefault
editable文本框可输入boolean-true
clearable是否显示清除按钮boolean-true
placeholder非范围选择时的占位内容string--
start-placeholder范围选择时开始日期的占位内容string--
end-placeholder范围选择时结束日期的占位内容string--
type显示类型stringenumdate
format显示在输入框中的格式string时间格式YYYY-MM-DD
popper-classDatePicker 下拉框的类string--
range-separator选择范围时的分隔符string--
default-value可选,选择器打开时默认显示的时间Date / [Date, Date]--
default-time范围选择时选中日期所使用的当日内具体时刻Date / [Date, Date]--
value-format可选,绑定值的格式。 不指定则绑定值为 Date 对象string时间格式-
id等价于原生 id 属性string / [string, string]--
name等价于原生 name 属性string--
unlink-panels在范围选择器里取消两个日期面板之间的联动boolean-false
prefix-icon自定义前缀图标string / Component-Date
clear-icon自定义清除图标string / Component-CircleClose
disabled-date一个用来判断该日期是否被禁用的函数,接受一个 Date 对象作为参数。 应该返回一个 Boolean 值function--
shortcuts设置快捷选项,需要传入数组对象Array<{ text: string, value: Date / Function }>--
cell-class-name设置自定义类名Function(Date)--
teleport指定挂载的节点,等同于 Teleport 组件的 to 属性string-body

Events

事件名说明回调参数
change用户确认选定的值时触发(val: typeof v-model)
blur在组件 Input 失去焦点时触发(e: FocusEvent)
focus在组件 Input 获得焦点时触发(e: FocusEvent)
calendar-change如果用户没有选择日期,那默认展示当前日的月份。 你可以使用 default-value 来设置成其他的日期(val: [Date, Date])
panel-change当日期面板改变时触发。(date, mode, view)
visible-change当 DatePicker 的下拉列表出现/消失时触发(visibility: boolean)

方法

通过 ref 可以获取到 DatePicker 实例并调用实例方法,详见组件实例方法

方法名说明参数
focus使 input 获取焦点-
handleOpen打开日期选择器弹窗-
handleClose关闭日期选择器弹窗-

Slots

插槽名说明
default自定义内容
range-separator自定义范围分割符内容

类型定义

组件导出以下类型定义:

ts
import type { DatePickerPcProps } from 'ryxon'

Released under the MIT License.