Ant Design Vue教程

Ant Design Vue DatePicker API属性和事件

日期类组件包括以下四种形式,DatePicker、MonthPicker、RangePicker、WeekPicker。

共同的属性

参数
说明类型默认值
allowClear是否显示清除按钮booleantrue
autoFocus自动获取焦点booleanfalse
dateRender作用域插槽,自定义日期单元格的内容slot="dateRender" slot-scope="current, today"-
disabled禁用booleanfalse
disabledDate不可选择的日期(currentDate: moment) => boolean
getCalendarContainer定义浮层的容器,默认为 body 上新建 divfunction(trigger)
locale国际化配置object默认配置
mode日期面板的状态time|date|month|year|decade'date'
open控制弹层是否展开boolean-
placeholder输入框提示文字string|RangePicker[]-
popupStyle额外的弹出日历样式object对象
比如{width:"100px",height:"100px"}
{}
dropdownClassName额外的弹出日历 classNamestring-
size输入框大小,large 高度为 40px,small 为 24px,默认是 32pxstring
suffixIcon自定义的选择框后缀图标VNode | slot

共同的事件

事件名称说明回调参数
openChange弹出日历和关闭日历的回调function(status)
panelChange日期面板变化时的回调function(value, mode)

共同的方法

事件名称说明
blur()移除焦点
panelChange获取焦点

DatePicker

属性名称
说明类型默认值
defaultValue默认日期
moment
defaultPickerValue默认面板日期moment
disabledTime不可选择的时间function(date)
format设置日期格式,为数组时支持多格式匹配,展示以第一个为准。配置参考 moment.jsstring | string[]"YYYY-MM-DD"
renderExtraFooter在面板中添加额外的页脚slot="renderExtraFooter" slot-scope="mode"-
showTime增加时间选择功能
<a-date-picker :showTime="{ format: 'HH:mm' }" > </a-date-picker>
Object|booleanTimePicker Options
showTime.defaultValue设置用户选择日期时默认的时分秒momentmoment()
showToday是否展示“今天”按钮booleantrue
value(v-model)日期moment

DatePicker事件

事件名称说明回调参数
change()时间发生变化的回调function(date: moment, dateString: string)
ok点击确定按钮的回调function()

MonthPicker 

MonthPicker属性

事件名称说明回调参数默认值
defaultValue默认日期moment
defaultPickerValue默认面板日期moment
format展示的日期格式,配置参考 moment.jsstring"YYYY-MM"
monthCellContentRender自定义的月份内容渲染方法slot="monthCellContentRender" slot-scope="date, locale"-
renderExtraFooter在面板中添加额外的页脚slot="renderExtraFooter" slot-scope="mode"
value(v-model)日期moment

MonthPicker事件

事件名称说明
回调参数
change时间发生变化的回调,发生在用户选择时间时function(date: moment, dateString: string)

WeekPicker属性

名称说明类型默认值
defaultValue默认日期moment-
defaultPickerValue默认面板日期moment
format展示的日期格式,配置参考 moment.jsstring"YYYY-wo"
value(v-model)日期moment-
renderExtraFooter在面板中添加额外的页脚slot="renderExtraFooter" slot-scope="mode"-

WeekPicker事件

事件名称说明
回调参数
change时间发生变化的回调,发生在用户选择时间时function(date: moment, dateString: string)

RangePicker属性

属性名称
说明类型默认值
ranges预设时间范围快捷选择{ [range: string]: moment[] } | { [range: string]: () => moment[] }
separator设置分隔符string'~'
defaultValue默认日期
moment
defaultPickerValue默认面板日期moment
disabledTime不可选择的时间function(date)
format设置日期格式,为数组时支持多格式匹配,展示以第一个为准。配置参考 moment.jsstring | string[]"YYYY-MM-DD"
renderExtraFooter在面板中添加额外的页脚slot="renderExtraFooter" slot-scope="mode"-
showTime增加时间选择功能
<a-date-picker :showTime="{ format: 'HH:mm' }" > </a-date-picker>
Object|booleanTimePicker Options
showTime.defaultValue设置用户选择日期时默认的时分秒momentmoment()
showToday是否展示“今天”按钮booleantrue
value(v-model)日期moment

RangePicker事件

事件名称说明回调参数
calendarChange待选日期发生变化的回调function(dates: [moment, moment], dateStrings: [string, string])
change()时间发生变化的回调function(date: moment, dateString: string)
ok点击确定按钮的回调function()
Catalog
快速入门 Dropdown 下拉菜单 Menu 导航菜单 Pagination 分页 Steps 步骤条 AutoComplete 自动填充 Cascader 级联选择 Checkbox 多选框 DatePicker 日期选择框 DatePicker 日期选择框用法 DatePicker 设置不可选日期 DatePicker 选择时间 DatePicker 设置日期格式 DatePicker 日期范围选择 DatePicker 定制日期单元格 DatePicker 自定义渲染 DatePicker 属性和事件 Input 输入框 InputNumber 数字输入框 Mentions 提及 Radio 单选框 Rate 评分组件 Select 下拉框 Slider 滑动输入条 Switch 开关