Datepicker
Angular Bootstrap 5 Datepicker
Date picker is a plugin that adds the function of selecting time without the necessity of using custom JavaScript code.
Note: Read the API tab to find all available options and advanced customization
Basic example
The datepicker allows users to enter a date either through text input, or by choosing a date from the calendar. Date pickers can be embedded into dialogs on mobile and text field dropdowns on desktop.
Inline version
Use the [inline]="true"
attribute to initialize and set the default date for an inline datepicker inside a block element.
Translations
The picker can be customized to add support for internationalization. Modify the component options to add translations.
Formats
Use format
input to display date in a human-friendly format.
Formatting rules
The following rules can be used to format any date:
Rule | Description | Result |
---|---|---|
d |
Date of the month | 1 – 31 |
dd |
Date of the month with a leading zero | 01 – 31 |
ddd |
Day of the week in short form | Sun – Sat |
dddd |
Day of the week in full form | Sunday – Saturday |
m |
Month of the year | 1 – 12 |
mm |
Month of the year with a leading zero | 01 – 12 |
mmm |
Month name in short form | Jan – Dec |
mmmm |
Month name in full form | January – December |
yy |
Year in short form * | 00 – 99 |
yyyy |
Year in full form | 2000 – 2999 |
Date limits
Set the minimum and maximum selectable dates with the minDate
and
maxDate
inputs.
Disabled dates
The filter
input accept function in which you can specify conditions for date
filtering. A result of true indicates that the date should be valid and a result of false
indicates that it should be disabled. In the following example all saturdays and sundays will
be disabled.
Input toggle
Add (click)="datepicker.open()"
method to the input element to enable toggling
on input click. It is also possible to remove the toggle button.
Custom toggle icon
You can customize the toggle icon by modifying icon
input of the toggle component.
Close without confirmation
With [confirmDateOnSelect]
set to true
datepicker will close automatically after date selection
Accessibility
We added proper aria attributes to the datepicker controls to make the component accessible. It's possible to change the values of those attributes by modifying the component options:
Datepicker - API
Import
Inputs
Name | Type | Default | Description |
---|---|---|---|
confirmDateOnSelect |
Boolean | false |
Closes datepicker modal when the date is selected |
filter |
Function | (date: Date) => boolean |
Disables dates that meet the specified condition |
format |
String | 'dd/mm/yyyy' |
Changes date format displayed in input |
inline |
Boolean | false |
Changes datepicker display mode to inline (dropdown) |
maxDate |
Date | - |
Changes max available date |
minDate |
Date | - |
Changes min available date |
removeCancelBtn |
Boolean | false |
Removes Cancel button from datepicker modal |
removeClearBtn |
Boolean | false |
Removes Cancel button from datepicker modal |
removeOkBtn |
Boolean | false |
Removes Ok button from datepicker modal |
startDate
|
Date | - |
Changes default date to which datepicker will navigate |
startDay
|
Number | 0 |
Changes default start day (0 for Sunday, 1 for Monday...) |
startView |
String | 'days' |
Changes default datepicker view (days/years/months) |
Options
Name | Type | Default | Description |
---|---|---|---|
cancelBtnLabel
|
String | 'Cancel selection' |
Changes cancel button aria label |
cancelBtnText
|
String | 'Cancel' |
Changes cancel button text |
clearBtnLabel
|
String | 'Clear selection' |
Changes clear button aria label |
clearBtnText
|
String | 'Clear' |
Changes clear button text |
monthsFull
|
Array |
[ 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August',
'September', 'October', 'November', 'December', ]
|
Changes array of months full names |
monthsShort
|
Array |
['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov',
'Dec']
|
Changes array of months short names |
okBtnLabel
|
String | 'Confirm selection' |
Changes ok button aria label |
nextMonthLabel
|
String | 'Next month' |
Changes next button aria label in days view |
nextMultiYearLabel
|
String | 'Next 24 years' |
Changes next button aria label in years view |
nextYearLabel
|
String | 'Next year' |
Changes next button aria label in months view |
okBtnText
|
String | 'Ok' |
Changes ok button text |
prevMonthLabel
|
String | 'Previous month' |
Changes previous button aria label in days view |
prevMultiYearLabel
|
String | 'Previous 24 years' |
Changes previous button aria label in years view |
prevYearLabel
|
String | 'Previous year' |
Changes previous button aria label in months view |
switchToDayViewLabel
|
String | 'Choose date' |
Changes view change button aria label in years view |
switchToMonthViewLabel
|
String | 'Choose date' |
Changes view change button aria label in months view |
switchToMultiYearViewLabel
|
String | 'Choose year and month' |
Changes view change button aria label in days view |
title |
String | 'Select date' |
Changes datepicker title |
weekdaysFull
|
Array |
['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday',
'Saturday']
|
Changes array of weekdays full names |
weekdaysNarrow
|
Array | ['S', 'M', 'T', 'W', 'T', 'F', 'S'] |
Changes array of weekdays narrow names |
weekdaysShort
|
Array | ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'] |
Changes array of weekdays short names |
Outputs
Name | Description |
---|---|
opened
|
This event fires immediately when the datepicker is opened. |
closed
|
This event fires immediately when the datepicker is closed. |
dateChanged
|
This event fires immediately when the new date is selected. |
Methods
Name | Description | Example |
---|---|---|
open |
Manually opens a datepicker |
datepicker.open()
|
close |
Manually closes a datepicker |
datepicker.close()
|