DatePicker 日期选择器

用于选择或输入日期

选择某一天

以”日“为基本单位,基础的日期选择控件

基本单位由 type 属性指定。通过 shortcuts 配置快捷选项,通过 disabledDate 函数,来设置禁用掉的日期。

Default
Picker with quick options

其他日期单位

You can choose week, month, year, quarter or multiple dates by extending the standard date picker component.

Week
Year
Month
Quarter
Dates
Years
Months
Quarters

选择一段时间

你可以通过如下例子来学习如何设置一个日期范围选择器。

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

Default
To
With quick options
To

选择月份范围

你当然还可以选择一个月的范围。

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

Default
To
With quick options
To

年份范围2.8.0

你可以通过如下例子来学习如何设置一个年份范围选择器。

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

Default
To
With quick options
To

Quarter Range 2.14.5

Picking a quarter range is supported.

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

Default
To
With quick options
To

单个面板 2.14.0

默认日期选择器范围有两个面板。如果你想要一个面板设置 single-panel 属性。

date range
-
month range
-
year range
-
quarter range
-

默认值

日期选择器会在用户未选择任何日期的时候默认展示当天的日期。你也可以使用 default-value 来修改这个默认的日期。请注意该值需要是一个可以解析的 new Date() 对象。

如果类型是 daterange, default-value 则会设置左边窗口的默认值。

date
daterange
-

日期格式

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

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

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

WARNING

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

Emits Date object
Value:
Use value-format
Value:
Timestamp
Value:

默认显示日期

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

默认情况下,开始日期和结束日期的时间部分都是选择日期当日的 00:00:00。通过 default-time 可以分别指定开始日期和结束日期的具体时刻。它接受最多两个日期对象的数组。其中第一项控制起始日期的具体时刻,第二项控制结束日期的具体时刻。

Component value:

-

设置自定义前缀的内容

前缀内容可以被自定义。

当你从其他vue组件或由渲染函数生成的组件中导入组件时, 你可以设置 prefix-icon 属性来定制前缀内容

set prefix-icon

pre

自定义内容

弹出框的内容是可以自定义的,在插槽内你可以获取到当前单元格的数据请注意,自定义内容结构应与默认结构一致,否则可能风格会不一致。

自定义图标 2.8.0

使用插槽自定义图标。

date
date range
-
month range
-
year range
To
quarter range
To

国际化

由于 Element Plus 的默认语言为英语,如果你需要设置其它的语言,请参考国际化文档。

要注意的是:日期相关的文字(月份,每一周的第一天等等)也都是通过国际化来配置的。

DatePicker API

Attributes

属性名说明类型默认值
value绑定值,对应官方 model-value;范围选择器应为长度为 2 的数组number / string / Date / array''
readonly是否只读booleanfalse
disabled是否禁用booleanfalse
size输入框尺寸enum—
editable输入框是否可编辑booleantrue
clearable是否显示清空按钮booleantrue
placeholder非范围模式的占位文本string''
startPlaceholder范围模式起始占位文本string—
endPlaceholder范围模式结束占位文本string—
type选择器类型enumdate
format输入框显示格式stringYYYY-MM-DD
popperClass下拉面板自定义类名string—
popperStyle下拉面板自定义样式string / object—
rangeSeparator范围分隔符string'-'
defaultValue日历默认显示日期object—
defaultTime选择范围时使用的时间值object—
valueFormat绑定值格式,不传时绑定值为 Datestring—
id原生 input 的 idstring / array—
name原生 input 的 namestring / array''
unlinkPanels范围选择时左右面板不联动booleanfalse
singlePanel范围选择时只显示一个面板booleanfalse
prefixIcon自定义前缀图标string / object''
clearIcon自定义清空图标string / objectCircleClose
validateEvent是否触发表单校验booleantrue
disabledDate判断日期是否禁用Function—
shortcuts快捷选项array[]
cellClassName自定义单元格类名Function—
teleported下拉是否挂载到 bodybooleantrue
emptyValues组件空值配置array—
valueOnClear清空后的返回值string / number / boolean / Function—
fallbackPlacements浮层兜底方位array['bottom', 'top', 'right', 'left']
placement下拉位置Placementbottom
showFooter是否显示底栏booleantrue
showConfirm是否显示确认按钮booleantrue
showWeekNumber是否显示周数booleanfalse
automaticDropdown聚焦输入框时是否自动弹出booleantrue

Events

事件名说明参数
onChange用户确认值或点击外部时触发Function
onBlur输入框失焦时触发Function
onFocus输入框聚焦时触发Function
onClear点击清空按钮时触发Function
onCalendarChange日历选中日期变化时触发,仅范围模式Function
onPanelChange点击导航按钮时触发Function
onVisibleChange下拉出现 / 消失时触发Function

Slots

插槽名说明
renderCell自定义单元格内容,对应官方 default 插槽
separator自定义范围分隔符内容,对应官方 range-separator 插槽
prevMonthIcon上个月图标
nextMonthIcon下个月图标
prevYearIcon上一年图标
nextYearIcon下一年图标

Exposes

名称说明类型
focus聚焦输入框Function
blur输入框失焦Function
handleOpen打开下拉面板Function
handleClose关闭下拉面板Function