ant-design-vue/components/date-picker/index.en-US.md

category	type	title	cover	coverDark
Components	Data Entry	DatePicker	https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*xXA9TJ8BTioAAAAAAAAAAAAADrJ8AQ/original	https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*3OpRQKcygo8AAAAAAAAAAAAADrJ8AQ/original

To select or input a date.

When To Use

By clicking the input box, you can select a date from a popup calendar.

API

There are five kinds of picker:

• DatePicker
• DatePicker[picker="month"]
• DatePicker[picker="week"]
• DatePicker[picker="year"]
• DatePicker[picker="quarter"]
• RangePicker

Localization

The default locale is en-US, if you need to use other languages, recommend to use internationalized components provided by us at the entrance. Look at: ConfigProvider.

If there are special needs (only modifying single component language), Please use the property: local. Example: default.

<template>
  <a-date-picker v-model:value="value" :locale="locale" />
</template>
<script>
  import locale from 'ant-design-vue/es/date-picker/locale/zh_CN';
  import { defineComponent } from 'vue';
  export default defineComponent({
    setup() {
      return {
        locale,
        value: null,
      };
    },
  });
</script>

<template>
  <a-config-provider :locale="locale">
    <a-date-picker v-model:value="value" />
  </a-config-provider>
</template>
<script>
  // The default locale is en-US, if you want to use other locale, just set locale in entry file globally.
  import dayjs from 'dayjs';
  import 'dayjs/locale/zh-cn';
  import locale from 'ant-design-vue/es/date-picker/locale/zh_CN';
  import { defineComponent } from 'vue';
  dayjs.locale('zh-cn');
  export default defineComponent({
    setup() {
      return {
        value: dayjs('2015-01-01', 'YYYY-MM-DD')
        dayjs,
        locale
      };
    },
  });
</script>

Common API

The following APIs are shared by DatePicker, RangePicker.

Property	Description	Type	Default	Version
allowClear	Whether to show clear button	boolean	true
autofocus	If get focus when component mounted	boolean	false
bordered	Whether has border style	boolean	true
dateRender	Custom rendering function for date cells	v-slot:dateRender="{current, today}"	-
disabled	Determine whether the DatePicker is disabled	boolean	false
disabledDate	Specify the date that cannot be selected	(currentDate: dayjs) => boolean	-
format	To set the date format, refer to dayjs. When an array is provided, all values are used for parsing and first value is used for formatting, support Custom Format	formatType	YYYY-MM-DD
dropdownClassName	To customize the className of the popup calendar	string	-
getPopupContainer	To set the container of the floating layer, while the default is to create a div element in body	function(trigger)	-
inputReadOnly	Set the readonly attribute of the input tag (avoids virtual keyboard on touch devices)	boolean	false
locale	Localization configuration	object	default
mode	The picker panel mode	time | date | month | year | decade	-
nextIcon	The custom next icon	slot	-	3.0
open	The open state of picker	boolean	-
picker	Set picker type	date | week | month | quarter | year	date	quarter
placeholder	The placeholder of date input	string | [string,string]	-
placement	The position where the selection box pops up	bottomLeft bottomRight topLeft topRight	bottomLeft	3.3.0
popupStyle	To customize the style of the popup calendar	CSSProperties	{}
presets	The preset ranges for quick selection	{ label: slot, value: dayjs }[]	-	4.0
prevIcon	The custom prev icon	slot	-	3.0
size	To determine the size of the input box, the height of large and small, are 40px and 24px respectively, while default size is 32px	large | middle | small	-
status	Set validation status	'error' | 'warning'	-	3.3.0
suffixIcon	The custom suffix icon	v-slot:suffixIcon	-
superNextIcon	The custom super next icon	slot	-	3.0
superPrevIcon	The custom super prev icon	slot	-	3.0
valueFormat	optional, format of binding value. If not specified, the binding value will be a Date object	string, date formats	-

Common Events

Events Name	Description	Arguments	Version
openChange	a callback function, can be executed whether the popup calendar is popped up or closed	function(status)
panelChange	callback when picker panel mode is changed	function(value, mode)

Common Methods

Name	Description	Version
blur()	remove focus
focus()	get focus

DatePicker

Property	Description	Type	Default	Version
defaultPickerValue	To set default picker date	dayjs	-
disabledTime	To specify the time that cannot be selected	function(date)	-
format	To set the date format, refer to dayjs	formatType	YYYY-MM-DD
renderExtraFooter	Render extra footer in panel	v-slot:renderExtraFooter="mode"	-
showNow	Whether to show 'Now' button on panel when showTime is set	boolean	-
showTime	To provide an additional time selection	object | boolean	TimePicker Options
showTime.defaultValue	To set default time of selected date, demo	dayjs	dayjs()
showToday	Whether to show Today button	boolean	true
value(v-model)	To set date	dayjs	-

DatePicker Events

Events Name	Description	Arguments	Version
change	a callback function, can be executed when the selected time is changing	function(date: dayjs | string, dateString: string)
ok	callback when click ok button	function(date: dayjs | string)

DatePicker[picker=year]

Property	Description	Type	Default	Version
format	To set the date format, refer to dayjs	formatType	YYYY

DatePicker[picker=quarter]

Property	Description	Type	Default	Version
format	To set the date format, refer to dayjs	formatType	YYYY-\QQ

DatePicker[picker=month]

Property	Description	Type	Default	Version
format	To set the date format, refer to dayjs	formatType	YYYY-MM
monthCellRender	Custom month cell content render method	v-slot:monthCellRender="{current, locale}"	-

DatePicker[picker=week]

Property	Description	Type	Default	Version
format	To set the date format, refer to dayjs	formatType	YYYY-wo

RangePicker

Property	Description	Type	Default	Version
allowEmpty	Allow start or end input leave empty	[boolean, boolean]	[false, false]
dateRender	Customize date cell.	v-slot:dateRender="{current: dayjs, today: dayjs, info: { range: start | end }}"	-
defaultPickerValue	To set default picker date	[dayjs, dayjs]	-
disabled	If disable start or end	[boolean, boolean]	-
disabledTime	To specify the time that cannot be selected	function(date: dayjs, partial: start | end)	-
format	To set the date format, refer to dayjs	formatType	YYYY-MM-DD HH:mm:ss
presets	The preset ranges for quick selection	{ label: slot, value: dayjs[] }[]	-	4.0
ranges	The preseted ranges for quick selection	{ [range: string]: dayjs[] } | { [range: string]: () => dayjs[] }	-
renderExtraFooter	Render extra footer in panel	v-slot:renderExtraFooter="mode"	-
separator	Set separator between inputs	string | v-slot:separator	<SwapRightOutlined />
showTime	To provide an additional time selection	object | boolean	TimePicker Options
showTime.defaultValue	To set default time of selected date, demo	dayjs[]	[dayjs(), dayjs()]
value(v-model)	To set date	[dayjs, dayjs]	-

RangePicker Events

Events Name	Description	Arguments	Version
calendarChange	Callback function, can be executed when the start time or the end time of the range is changing.	function(dates: [dayjs, dayjs], dateStrings: [string, string], info: { range:start|end })	-
change	a callback function, can be executed when the selected time is changing	function(dates: [dayjs, dayjs] | [string, string], dateStrings: [string, string])
ok	callback when click ok button	function(dates: [dayjs, dayjs] | [string, string])

formatType

import type { Dayjs } from 'dayjs';

type Generic = string;
type GenericFn = (value: Dayjs) => string;

export type FormatType = Generic | GenericFn | Array<Generic | GenericFn>;

FAQ

How to use DatePicker with customize date library（like moment.js | dayjs | date-fns）？

Please refer replace date

Why config dayjs.locale globally not work?

DatePicker default set locale as en in v4. You can config DatePicker locale prop or ConfigProvider locale prop instead.

How to modify start day of week?

Please use correct language (#5605), or update dayjs locale config:

• Example: https://codesandbox.io/s/dayjs-day-of-week-x9tuj2?file=/demo.tsx

import dayjs from 'dayjs';
import updateLocale from 'dayjs/plugin/updateLocale';
import 'dayjs/locale/zh-cn';

dayjs.extend(updateLocale);
dayjs.updateLocale('zh-cn', {
  weekStart: 0,
});