Datepicker
Vue Bootstrap 5 Datepicker
Date picker is a component that adds the function of selecting date without the necessity of using a custom 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
prop 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 props to add translations.
Formats
Use format
property to display date in a human-friendly format.
Formatting rules
The following rules can be used to format any date:
Rule | Description | Result |
---|---|---|
D |
Day of the month | 1 – 31 |
DD |
Day 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 min
and
max
props.
Disable past
Use the disablePast
option to disallow past date selection.
Disable future
Use the disableFuture
option to disallow past date selection.
Disabled dates
The fitler
option 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 inputToggle
property to enable toggling on input
click. It is also possible to set toggleButton
option to false
to
remove the toggle button.
Custom toggle icon
You can customize the toggle icon by adding a toggleIcon
alternative string template to the
component.
Confirm date on select
If you want to be able to confirm the date on select and close the
modal you can add confirmDateOnSelect
prop to you
MDBDatepicker
component. You can hide the buttons from
the modal if they are not going to be used.
Custom header content
You can edit the contents MDBDatepicker
header by adding
a named scoped slot and customHeader
prop. You have
access to 4 values:
selected, headerWeekday, headerMonth and headerMonthday
which you can use however you like.
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 modyfing the component properties:
Datepicker - API
Import
Properties
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 |
confirmDateOnSelect
|
Boolean | false |
Allows to pick date on select |
container
|
String | 'body' |
Allows to change the container for the modal. Container prop should be a valid selector of element that is mounted before the Teleport happens. |
customHeader
|
Boolean | false |
Allows to change header content together with named scoped slots. |
disablePast
|
Boolean | false |
Disables selection of past dates |
disableFuture
|
Boolean | false |
Disables selection of future dates |
filter |
Function | () => false |
Enables filtering |
format |
String | 'DD/MM/YYYY' |
Changes date format displayed in input |
inline |
Boolean | false |
Changes datepicker display mode to inline (dropdown) |
inputToggle |
Boolean | false |
Enables input toggling |
max |
Date | - |
Changes max available date |
min |
Date | - |
Changes min available date |
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 |
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 |
okBtnLabel
|
String | 'Confirm selection' |
Changes ok button aria label |
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 |
removeClearBtn
|
Boolean | false |
Removes clear button from datepicker modal |
removeCancelBtn
|
Boolean | false |
Removes cancel button from datepicker modal |
removeOkBtn
|
Boolean | false |
Removes ok button from datepicker modal |
startDate
|
String | '' |
Changes default date to which datepicker will navigate |
startDay
|
Number | 0 |
Changes default start day (0 for Sunday, 1 for Monday) |
switchToDayViewLabel
|
String | 'Choose date' |
Changes view change button aria label in years view |
switchToMultiYearViewLabel
|
String | 'Choose year and month' |
Changes view change button aria label in days view |
title |
String | 'Select date' |
Changes datepicker title |
toggleButton |
Boolean | false |
Enables toggle button |
toggleIcon |
String | "<i class='far fa-calendar datepicker-toggle-icon'></i>" |
Defines toggle icon template |
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 |
view |
String | 'day' |
Changes default datepicker view (day/year/month) |
v-model |
String | '' |
Returns current picked date |
Methods
Name | Description | Example |
---|---|---|
open |
Manually opens a datepicker |
pickerRef.open()
|
close |
Manually closes a datepicker |
pickerRef.close()
|
Events
Name | Description |
---|---|
close
|
This event fires immediately when the datepicker is closed. |
open
|
This event fires immediately when the datepicker is opened. |
update:modelValue
|
This event fires immediately when the datepicker value is changed. |
update:isValid
|
This event fires immediately when the datepicker valid value is changed |
update:isValidated
|
This event fires immediately when the datepicker validation value is changed |
viewChanged
|
This event fires immediately when the datepicker view is changed |
CSS variables
As part of MDB’s evolving CSS variables approach, datepicker now use local CSS variables for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.
Datepicker CSS variables are in different classes which belong to this component. To make it easier to use them, you can find below all of the used CSS variables.