Calendar

Calendar, also known as DatePicker, is a form component to work with dates.


import Calendar from 'primevue/calendar';

Calendar is used a controlled input component with v-model property.


<Calendar v-model="date" />

Default date format is mm/dd/yy which can be customized using the dateFormat property. Following options can be a part of the format.

  • d - day of month (no leading zero)
  • dd - day of month (two digit)
  • o - day of the year (no leading zeros)
  • oo - day of the year (three digit)
  • D - day name short
  • DD - day name long
  • m - month of year (no leading zero)
  • mm - month of year (two digit)
  • M - month name short
  • MM - month name long
  • y - year (two digit)
  • yy - year (four digit)
  • @ - Unix timestamp (ms since 01/01/1970)
  • ! - Windows ticks (100ns since 01/01/0001)
  • '...' - literal text
  • '' - single quote
  • anything else - literal text

<Calendar v-model="date" dateFormat="dd/mm/yy" />

Locale for different languages and formats is defined globally, refer to the PrimeVue Locale configuration for more information.

An additional icon is displayed next to the input field when showIcon is present.


<Calendar v-model="buttondisplay" showIcon :showOnFocus="false" />
<Calendar v-model="icondisplay" showIcon iconDisplay="input" />
<Calendar v-model="templatedisplay" showIcon iconDisplay="input" timeOnly>
    <template #inputicon="{ clickCallback }">
        <InputIcon class="pi pi-clock cursor-pointer" @click="clickCallback" />
    </template>
</Calendar>

Boundaries for the permitted dates that can be entered are defined with minDate and maxDate properties.


<Calendar v-model="date" :minDate="minDate" :maxDate="maxDate" :manualInput="false" />

In order to choose multiple dates, set selectionMode as multiple. In this mode, the value binding should be an array.


<Calendar v-model="dates" selectionMode="multiple" :manualInput="false" />

A range of dates can be selected by defining selectionMode as range, in this case the bound value would be an array with two values where first date is the start of the range and second date is the end.


<Calendar v-model="dates" selectionMode="range" :manualInput="false" />

When showButtonBar is present, today and clear buttons are displayed at the footer.


<Calendar v-model="date" showButtonBar />

A time picker is displayed when showTime is enabled where 12/24 hour format is configured with hourFormat property. In case, only time needs to be selected, add timeOnly to hide the date section.


<Calendar id="calendar-12h" v-model="datetime12h" showTime hourFormat="12" />
<Calendar id="calendar-24h" v-model="datetime24h" showTime hourFormat="24" />
<Calendar id="calendar-timeonly" v-model="time" timeOnly />

Month only picker is enabled by specifying view as month in addition to a suitable dateFormat.


<Calendar v-model="date" view="month" dateFormat="mm/yy" />

Specifying view as year in addition to a suitable dateFormat enables the year picker.


<Calendar v-model="date" view="year" dateFormat="yy" />

Number of months to display is configured with the numberOfMonths property.


<Calendar v-model="date" :numberOfMonths="2" />

Custom content can be placed inside date cells with the date slot that takes a Date as a parameter.


<Calendar v-model="date">
    <template #date="slotProps">
        <strong v-if="slotProps.date.day > 10 && slotProps.date.day < 15" style="text-decoration: line-through">{{ slotProps.date.day }}</strong>
        <template v-else>{{ slotProps.date.day }}</template>
    </template>
</Calendar>

When touchUI is enabled, overlay is displayed as optimized for touch devices.


<Calendar v-model="date" touchUI />

Calendar is used a controlled input component with v-model property.

WkSuMoTuWeThFrSa
172829301234
18567891011
1912131415161718
2019202122232425
212627282930311

<Calendar v-model="date" inline showWeek />

A floating label appears on top of the input field when focused. Visit FloatLabel documentation for more information.


<FloatLabel>
    <Calendar v-model="date" inputId="birth_date" />
    <label for="birth_date">Birth Date</label>
</FloatLabel>

Specify the variant property as filled to display the component with a higher visual emphasis than the default outlined style.


<Calendar v-model="date" variant="filled" />

Calendar is used a controlled input component with v-model property.


<Calendar v-model="date" invalid />

Calendar is used a controlled input component with v-model property.


<Calendar v-model="date" disabled />

Screen Reader

Value to describe the component can either be provided via label tag combined with inputId prop or using aria-labelledby, aria-label props. The input element has combobox role in addition to aria-autocomplete as "none", aria-haspopup as "dialog" and aria-expanded attributes. The relation between the input and the popup is created with aria-controls attribute that refers to the id of the popup.

The optional calendar button requires includes aria-haspopup, aria-expanded for states along with aria-controls to define the relation between the popup and the button. The value to read is retrieved from the chooseDate key of the aria property from the locale API. This label is also used for the aria-label of the popup as well. When there is a value selected, it is formatted and appended to the label to be able to notify users about the current value.

Popup has a dialog role along with aria-modal and aria-label. The navigation buttons at the header has an aria-label retrieved from the prevYear, nextYear, prevMonth, nextMonth, prevDecade and nextDecade keys of the locale aria API. Similarly month picker button uses the chooseMonth and year picker button uses the chooseYear keys.

Main date table uses grid role that contains th elements with col as the scope along with abbr tag resolving to the full name of the month. Each date cell has an aria-label referring to the full date value. Buttons at the footer utilize their readable labels as aria-label as well. Selected date also receives the aria-selected attribute.

Timepicker spinner buttons get their labels for aria-label from the aria locale API using the prevHour, nextHour, prevMinute, nextMinute, prevSecond, nextSecond, am and pm keys.

Calendar also includes a hidden section that is only available to screen readers with aria-live as "polite". This element is updated when the selected date changes to instruct the user about the current date selected.


<label for="date1">Date</label>
<Calendar inputId="date1" />

<span id="date2">Date</span>
<Calendar aria-labelledby="date2" />

<Calendar aria-label="Date" />

Choose Date Button Keyboard Support

KeyFunction
spaceOpens popup and moves focus to the selected date, if there is none focuses on today.
enterOpens popup and moves focus to the selected date, if there is none focuses on today.

Popup Keyboard Support

KeyFunction
escapeCloses the popup and moves focus to the input element.
tabMoves focus to the next focusable element within the popup.
shift + tabMoves focus to the next focusable element within the popup.

Header Buttons Keyboard Support

KeyFunction
enterTriggers the button action.
spaceTriggers the button action.

Date Grid Keyboard Support

KeyFunction
enterSelects the date, closes the popup and moves focus to the input element.
spaceCloses the popup and moves focus to the input element.
up arrowMoves focus to the same day of the previous week.
alt + up arrowCloses the popup and moves focus to the input element.
down arrowMoves focus to the same day of the next week.
right arrowMoves focus to the next day.
left arrowMoves focus to the previous day.
homeMoves focus to the first day of the current week.
endMoves focus to the last day of the current week.
page upChanges the date to previous month in date picker mode. Moves to previous year in month picker mode and previous decade in year picker.
shift + page upChanges the date to previous year in date picker mode. Has no effect in month or year picker.
page downChanges the date to next month in date picker mode. Moves to next year in month picker mode and next decade in year picker.
shift + page downChanges the date to next year in date picker mode. Has no effect in month or year picker.

Footer Buttons Keyboard Support

KeyFunction
enterTriggers the button action.
spaceTriggers the button action.