Ant Design Vue DatePicker API属性和事件
日期类组件包括以下四种形式,DatePicker、MonthPicker、RangePicker、WeekPicker。
共同的属性
参数
| 说明 | 类型 | 默认值 |
---|
allowClear | 是否显示清除按钮 | boolean | true |
autoFocus | 自动获取焦点 | boolean | false |
dateRender | 作用域插槽,自定义日期单元格的内容 | slot="dateRender" slot-scope="current, today" | - |
disabled | 禁用 | boolean | false |
disabledDate | 不可选择的日期 | (currentDate: moment) => boolean | 无 |
getCalendarContainer | 定义浮层的容器,默认为 body 上新建 div | function(trigger) | 无 |
locale | 国际化配置 | object | 默认配置 |
mode | 日期面板的状态 | time|date|month|year|decade | 'date' |
open | 控制弹层是否展开 | boolean | - |
placeholder | 输入框提示文字 | string|RangePicker[] | - |
popupStyle | 额外的弹出日历样式 | object对象 比如{width:"100px",height:"100px"} | {} |
dropdownClassName | 额外的弹出日历 className | string | - |
size | 输入框大小,large 高度为 40px,small 为 24px,默认是 32px | string | 无 |
suffixIcon | 自定义的选择框后缀图标 | VNode | slot |
|
共同的事件
事件名称 | 说明 | 回调参数 |
---|
openChange | 弹出日历和关闭日历的回调 | function(status) |
panelChange | 日期面板变化时的回调 | function(value, mode) |
共同的方法
事件名称 | 说明 |
---|
blur() | 移除焦点 |
panelChange | 获取焦点 |
DatePicker
属性名称
| 说明 | 类型 | 默认值 |
---|
defaultValue | 默认日期
| moment | 无 |
defaultPickerValue | 默认面板日期 | moment | 无 |
disabledTime | 不可选择的时间 | function(date) | 无 |
format | 设置日期格式,为数组时支持多格式匹配,展示以第一个为准。配置参考 moment.js | string | string[] | "YYYY-MM-DD" |
renderExtraFooter | 在面板中添加额外的页脚 | slot="renderExtraFooter" slot-scope="mode" | - |
showTime | 增加时间选择功能 <a-date-picker :showTime="{ format: 'HH:mm' }" > </a-date-picker> | Object|boolean | TimePicker Options |
showTime.defaultValue | 设置用户选择日期时默认的时分秒 | moment | moment() |
showToday | 是否展示“今天”按钮 | boolean | true |
value(v-model) | 日期 | moment | 无 |
DatePicker事件
事件名称 | 说明 | 回调参数 |
---|
change() | 时间发生变化的回调 | function(date: moment, dateString: string) |
ok | 点击确定按钮的回调 | function() |
MonthPicker
MonthPicker属性
事件名称 | 说明 | 回调参数 | 默认值 |
---|
defaultValue | 默认日期 | moment | 无 |
defaultPickerValue | 默认面板日期 | moment | 无 |
format | 展示的日期格式,配置参考 moment.js | string | "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.js | string | "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.js | string | string[] | "YYYY-MM-DD" |
renderExtraFooter | 在面板中添加额外的页脚 | slot="renderExtraFooter" slot-scope="mode" | - |
showTime | 增加时间选择功能 <a-date-picker :showTime="{ format: 'HH:mm' }" > </a-date-picker> | Object|boolean | TimePicker Options |
showTime.defaultValue | 设置用户选择日期时默认的时分秒 | moment | moment() |
showToday | 是否展示“今天”按钮 | boolean | true |
value(v-model) | 日期 | moment | 无 |
RangePicker事件
事件名称 | 说明 | 回调参数 |
---|
calendarChange | 待选日期发生变化的回调 | function(dates: [moment, moment], dateStrings: [string, string]) |
change() | 时间发生变化的回调 | function(date: moment, dateString: string) |
ok | 点击确定按钮的回调 | function() |