DateTimePicker 日期时间选择器
在同一个选择器里选择日期和时间
TIP
日期时间选择器来自日期选择器和时间选择器的组合。 关于属性的详细解释,请参阅日期选择器和时间选择器。
日期和时间点
日期时间格式
日期和时间范围
默认的起始与结束时刻
API
Props
参数 | 说明 | 类型 | 可选值 | 默认值 |
---|---|---|---|---|
model-value / v-model | 绑定值,如果它是数组,长度应该是 2 | enum | - | - |
readonly | 只读 | boolean | - | false |
disabled | 禁用 | boolean | - | false |
size | 输入框尺寸 | string | enum | default |
editable | 文本框可输入 | boolean | - | true |
clearable | 是否显示清除按钮 | boolean | - | true |
placeholder | 非范围选择时的占位内容 | string | - | - |
start-placeholder | 范围选择时开始日期的占位内容 | string | - | - |
end-placeholder | 范围选择时结束日期的占位内容 | string | - | - |
type | 显示类型 | string | enum | date |
format | 显示在输入框中的格式 | string | 时间格式 | YYYY-MM-DD |
popper-class | DatePicker 下拉框的类 | 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'