日期选择器

用于选择或输入日期(经典版,范围默认双面板)。推荐新项目使用 DatePicker Pro

组件选型

组件说明
DatePicker(本文档)经典日期选择器
DatePicker ProPro 单面板范围
DateTimePicker日期 + 时刻
TimePicker仅时刻
DatePickerPanel独立面板

单点选择

日期 date

type="date"shortcutsdisabledDate

默认
带快捷选项
🎉 点击尾部
🎉 轻量化
禁用
禁用

禁用日期 disabled-date

通过 disabled-date 函数控制哪些日期不可选,函数接收 Date 参数,返回 true 表示禁用。

禁用今天之后的日期
禁用今天之前的日期
禁用周末

周、月、年、多个日期

多个日期
多个年
多个月

范围选择

默认左右双面板联动unlink-panels 可解除联动。

日期范围 daterange

默认
-
快捷选项
-
🎉 轻量化
-

月份范围 monthrange

默认
-
快捷选项
-

年份范围 yearrange

默认
-
快捷选项
-

格式与绑定值

显示格式与 value-format

使用 format 指定输入框格式,value-format 指定绑定值格式;默认为 Date 对象。

Day.js 格式说明

格式输出描述
YY18两位数的年份
YYYY2018四位数的年份
M1-12月份,从 1 开始
MM01-12月份,两位数
MMMJan-Dec简写的月份名称
MMMMJanuary-December完整的月份名称
D1-31月份里的一天
DD01-31月份里的一天,两位数
d0-6一周中的一天,星期天是 0
ddSu-Sa最简写的一周中一天的名称
dddSun-Sat简写的一周中一天的名称
ddddSunday-Saturday一周中一天的名称
H0-23小时
HH00-23小时,两位数
h1-12小时, 12 小时制
hh01-12Hours, 12 小时制, 两位数
m0-59分钟
mm00-59分钟,两位数
s0-59
ss00-59秒 两位数
SSS000-999毫秒 三位数
Z+5:00UTC 的偏移量
ZZ+0500UTC 的偏移量,数字前面加上 0
AAM PM
aam pm

WARNING

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

Date object
value-format
Timestamp

change 附带格式化字符串 emit-formatted-value

开启后,change 事件的第二个参数为格式化字符串;v-model 仍为 DateDate[](未设置 value-format 时)。

日期选择器
周选择器
时间选择器
范围选择器
-

打开时的默认日期 default-value

设置默认值
日期范围
-

范围选中日期的默认时刻 default-time

-

自定义

前缀 / 后缀图标

后缀默认显示日历图标;前缀仅在有 prefix-icon 时显示。详见 DatePicker Pro

set suffix-icon

pre

set suffix-icon

pre

-

单元格内容

前缀/清除图标插槽

日期选择器
日期范围选择器
-
月份范围选择器
-
年份范围选择器
-
ts
interface DateCell {
  column: number
  customClass: string
  disabled: boolean
  end: boolean
  inRange: boolean
  row: number
  selected: Dayjs
  isCurrent: boolean
  isSelected: boolean
  start: boolean
  text: number
  timestamp: number
  date: Date
  dayjs: Dayjs
  type: 'normal' | 'today' | 'week' | 'next-month' | 'prev-month'
}

国际化

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

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

API

属性

参数说明类型默认值Version
model-value / v-model绑定值,如果它是数组,长度应该是 2number / string / Date / array''
readonly只读booleanfalse
disabled禁用booleanfalse
size输入框尺寸enum
editable文本框可输入booleantrue
clearable是否显示清除按钮booleantrue
placeholder非范围选择时的占位内容string''
start-placeholder范围选择时开始日期的占位内容string
end-placeholder范围选择时结束日期的占位内容string
type显示类型enumdate
format显示在输入框中的格式参见 date formatsYYYY-MM-DD
popper-classDatePicker 下拉框的类名string
popper-options自定义 popper 选项,更多请参考 popper.jsobject{}
teleported是否使用 teleport;为 true 时下拉层挂载到 append-to 指定位置booleantrue
append-to下拉层挂载到哪个 DOM 元素string
range-separator选择范围时的分隔符string'-'
default-value可选,选择器打开时默认显示的时间object
default-time范围选择时选中日期所使用的当日内具体时刻object
value-format可选,绑定值的格式。 不指定则绑定值为 Date 对象参见 格式与绑定值
id等价于原生 input id 属性string / object
name等价于原生 input name 属性string / object''
unlink-panels在范围选择器里取消两个日期面板之间的联动booleanfalse
prefix-icon自定义前缀图标;未设置时不显示string / object''
suffix-icon自定义后缀图标;未设置时默认为日历/时钟图标string / object''
clear-icon自定义清除图标string / objectCircleCloseFilled
validate-event是否触发表单验证booleantrue
disabled-date一个用来判断该日期是否被禁用的函数,接受一个 Date 对象作为参数。 应该返回一个 Boolean 值。Function
shortcuts设置快捷选项,需要传入数组对象object[]
cell-class-name设置自定义类名Function
empty-values组件的空值配置 参考 config-providerarray
value-on-clear清空选项的值 参考 config-providerstring / number / boolean / Function
fallback-placementsTooltip 可用的 positions 请查看popper.js 文档array['bottom','top','right','left']
placement下拉框出现的位置Placementbottom-start
trigger-suffix点击后缀图标触发下拉框booleanfalseV0.0.8
plain朴素的 DatePickerbooleanfalseV0.0.8
emit-formatted-valuechange 事件是否附带格式化字符串(第二参数)booleanfalseV0.0.8

事件

事件名说明类型
change用户确认选定的值时触发Function
blur在组件 Input 失去焦点时触发Function
focus在组件 Input 获得焦点时触发Function
clear可清空的模式下用户点击清空按钮时触发Function
calendar-change在日历所选日期更改时触发Function
panel-change当日期面板改变时触发。Function
visible-change当 DatePicker 的下拉列表出现/消失时触发Function

插槽

名称说明
default自定义单元格内容
range-separator自定义范围分割符内容

暴露

插槽名说明类型
focus使组件获取焦点Function
blur使组件失去焦点Function
handleOpen打开日期选择器弹窗Function
handleClose关闭日期选择器弹窗Function

类型声明

显示类型声明
ts
import type { Options as PopperOptions } from '@popperjs/core'

type TimeLikeType = 'datetime' | 'datetimerange'

type Placement =
  | 'top'
  | 'top-start'
  | 'top-end'
  | 'bottom'
  | 'bottom-start'
  | 'bottom-end'
  | 'left'
  | 'left-start'
  | 'left-end'
  | 'right'
  | 'right-start'
  | 'right-end'

Copyright 2025 Winning Health 版权所有