File: calendar.md | Updated: 11/15/2025
Introducing PrimeReact v11 Alpha 🥁Learn More
SearchK
10.9.7
FEATURES
API
THEMING
PASS THROUGH
Calendar, also known as DatePicker, is a form component to work with dates.
Import#
import { Calendar } from 'primereact/calendar';
Copy
Basic#
Calendar is used a controlled input component with value and onChange properties.
<Calendar value={date} onChange={(e) => setDate(e.value)} />
Copy
Format#
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 value={date} onChange={(e) => setDate(e.value)} dateFormat="dd/mm/yy" />
Copy
Locale#
Locale based settings such as labels, dateFormat and firstDayOfWeek are derived from the global Locale configuration. In case, a certain calendar needs to be customized, locale property can be used to override the global setting.
<Calendar value={date} onChange={(e) => setDate(e.value)} locale="es" />
Copy
Icon#
An additional icon is displayed next to the input field when showIcon is present.
Button Display
Icon Display
Icon Template
<Calendar value={date} onChange={(e) => setDate(e.value)} showIcon />
Copy
Min / Max#
Boundaries for the permitted dates that can be entered are defined with minDate and maxDate properties.
<Calendar id="minmax" value={date} onChange={(e) => setDate(e.value)} minDate={minDate} maxDate={maxDate} readOnlyInput />
Copy
Multiple#
In order to choose multiple dates, set selectionMode as multiple. In this mode, the value binding should be an array.
<Calendar value={dates} onChange={(e) => setDates(e.value)} selectionMode="multiple" readOnlyInput />
Copy
Range#
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 value={dates} onChange={(e) => setDates(e.value)} selectionMode="range" readOnlyInput hideOnRangeSelection />
Copy
Button Bar#
When showButtonBar is present, today and clear buttons are displayed at the footer.
<Calendar value={date} onChange={(e) => setDate(e.value)} showButtonBar />
Copy
Time#
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.
12h Format
24h Format
Time Only
<Calendar value={datetime12h} onChange={(e) => setDateTime12h(e.value)} showTime hourFormat="12" />
<Calendar value={datetime24h} onChange={(e) => setDateTime24h(e.value)} showTime hourFormat="24" />
<Calendar value={time} onChange={(e) => setTime(e.value)} timeOnly />
Copy
Month Picker#
Month only picker is enabled by specifying view as month in addition to a suitable dateFormat.
<Calendar value={date} onChange={(e) => setDate(e.value)} view="month" dateFormat="mm/yy" />
Copy
Year Picker#
Specifying view as year in addition to a suitable dateFormat enables the year picker.
<Calendar value={date} onChange={(e) => setDate(e.value)} view="year" dateFormat="yy" />
Copy
Multiple Months#
Number of months to display is configured with the numberOfMonths property.
<Calendar value={date} onChange={(e) => setDate(e.value)} numberOfMonths={3} />
Copy
Date Template#
Custom content can be placed inside date cells with the dateTemplate property that takes a Date as a parameter.
<Calendar value={date} onChange={(e) => setDate(e.value)} dateTemplate={dateTemplate} />
Copy
Touch UI#
When touchUI is enabled, overlay is displayed as optimized for touch devices.
<Calendar value={date} onChange={(e) => setDate(e.value)} touchUI />
Copy
Inline#
Calendar is displayed as a popup by default, add inline property to customize this behavior.
November2025
| Wk | Su | Mo | Tu | We | Th | Fr | Sa | | --- | --- | --- | --- | --- | --- | --- | --- | | 43 | 26 | 27 | 28 | 29 | 30 | 31 | 1 | | 44 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | | 45 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | | 46 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | | 47 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | | 48 | 30 | 1 | 2 | 3 | 4 | 5 | 6 |
<Calendar value={date} onChange={(e) => setDate(e.value)} inline showWeek />
Copy
Filled#
Specify the variant property as filled to display the component with a higher visual emphasis than the default outlined style.
<Calendar variant="filled" value={date} onChange={(e) => setDate(e.value)} />
Copy
Float Label#
A floating label appears on top of the input field when focused. Visit FloatLabel documentation for more information.
Birth Date
<FloatLabel>
<Calendar inputId="birth_date" value={date} onChange={(e) => setDate(e.value)} />
<label htmlFor="birth_date">Birth Date</label>
</FloatLabel>
Copy
Invalid#
Invalid state is displayed using the invalid prop to indicate a failed validation. You can use this style when integrating with form validation libraries.
<Calendar invalid/>
Copy
Disabled#
When disabled is present, the element cannot be edited and focused.
<Calendar disabled />
Copy
Accessibility#
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 htmlFor="date1">Date</label>
<Calendar inputId="date1" />
<span id="date2">Date</span>
<Calendar aria-labelledby="date2" />
<Calendar aria-label="Date" />
Copy
| Key | Function | | --- | --- | | space | Opens popup and moves focus to the selected date, if there is none focuses on today. | | enter | Opens popup and moves focus to the selected date, if there is none focuses on today. |
| Key | Function | | --- | --- | | escape | Closes the popup and moves focus to the input element. | | tab | Moves focus to the next focusable element within the popup. | | shift + tab | Moves focus to the next focusable element within the popup. |
| Key | Function | | --- | --- | | enter | Triggers the button action. | | space | Triggers the button action. |
| Key | Function | | --- | --- | | enter | Selects the date, closes the popup and moves focus to the input element. | | space | Selects the date, closes the popup and moves focus to the input element. | | up arrow | Moves focus to the same day of the previous week. | | down arrow | Moves focus to the same day of the next week. | | right arrow | Moves focus to the next day. | | left arrow | Moves focus to the previous day. | | home | Moves focus to the first day of the current week. | | end | Moves focus to the last day of the current week. | | page up | Changes 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 up | Changes the date to previous year in date picker mode. Has no effect in month or year picker | | page down | Changes 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 down | Changes the date to next year in date picker mode. Has no effect in month or year picker |
| Key | Function | | --- | --- | | enter | Triggers the button action. | | space | Triggers the button action. |
Import
Basic
Format
Locale
Icon
Min / Max
Multiple
Range
Button Bar
Time
Month Picker
Year Picker
Multiple Months
Date Template
Touch UI
Inline
Filled
Float Label
Invalid
Disabled
Accessibility
PrimeReact 10.9.7 by PrimeTek