Form Datepicker

<b-form-datepicker> is a BootstrapVue custom date picker input form control, which provides full WAI-ARIA compliance and internationalization support.

As a form control wrapper component for the <b-calendar> component, it provides additional validation state presentation and a compact interface. Native HTML5 date inputs vary in presentation, accessibility, and in some instances are not supported by all browsers. <b-form-datepicker> provides a consistent and accessible interface across all browser platforms and devices.

The <b-form-datepicker> component was introduced in BootstrapVue release v2.5.0.

    <label for="example-datepicker">Choose a date</label>
    <b-form-datepicker id="example-datepicker" v-model="value" class="mb-2"></b-form-datepicker>
    <p>Value: '{{ value }}'</p>

  export default {
    data() {
      return {
        value: ''

<!-- b-form-datepicker.vue -->

<b-form-datepicker> supports many of the props available on <b-calendar> as well as some of the props available on <b-dropdown>.

v-model return value

By default, <b-form-datepicker> returns dates as a string in the YYYY-MM-DD format, which is the same format returned by native browser <input type="date"> controls. You can have <b-form-datepicker> return a Date object (with no time portion) as the v-model value instead by setting the value-as-date prop.

If no date is selected, <b-form-datepicker> returns an empty string '', or returns null if the value-as-date prop is set.

Note that when value-as-date prop is set, the returned Date object will be in the browser's default timezone.

If <b-form-datepicker> has a value set for the name prop, a hidden input will be created which will have its name attribute set to the value of the name prop, and the value attribute will be set to the selected date as a YYYY-MM-DD string. This will allow the <b-form-datepicker> selected value to be submitted via native browser form submission.

Disabled and readonly states

Setting the disabled prop will remove all interactivity of the <b-form-datepicker> component.

Setting the readonly prop will disable selecting a date, but will keep the component interactive, allowing for date navigation. The v-model will not be updated in the readonly state.

For disabling specific dates or setting minimum and maximum date limits, refer to the Date constraints section.

    <b-form-group label="Select date picker interactive state">
      <b-form-radio-group v-model="state" aria-controls="ex-disabled-readonly">
        <b-form-radio value="disabled">Disabled</b-form-radio>
        <b-form-radio value="readonly">Readonly</b-form-radio>
        <b-form-radio value="normal">Normal</b-form-radio>
    <b-form-datepicker id="ex-disabled-readonly" :disabled="disabled" :readonly="readonly"></b-form-datepicker>

  export default {
    data() {
      return {
        state: 'disabled'
    computed: {
      disabled() {
        return this.state === 'disabled'
      readonly() {
        return this.state === 'readonly'

<!-- b-form-datepicker-disabled-readonly.vue -->

Date constraints

Minimum and maximum dates

Restrict the calendar range via the min and max props. The props accept a date string in the format of YYYY-MM-DD or a Date object.

    <b-form-datepicker v-model="value" :min="min" :max="max" locale="en"></b-form-datepicker>

  export default {
    data() {
      const now = new Date()
      const today = new Date(now.getFullYear(), now.getMonth(), now.getDate())
      // 15th two months prior
      const minDate = new Date(today)
      minDate.setMonth(minDate.getMonth() - 2)
      // 15th in two months
      const maxDate = new Date(today)
      maxDate.setMonth(maxDate.getMonth() + 2)

      return {
        value: '',
        min: minDate,
        max: maxDate

<!-- b-form-datepicker-min-max.vue -->

Disabling dates

If you need to disable specific dates within the date picker, specify a function reference to the date-disabled-fn prop. The function is passed two arguments:

  • ymd The date as a YYYY-MM-DD string
  • date The date as a Date object

The function should either return true if the date cannot be selected (disabled), or false if the date can be selected (enabled). Note that the function cannot be asynchronous, and should return a value as quickly as possible.

    <b-form-datepicker v-model="value" :date-disabled-fn="dateDisabled" locale="en"></b-form-datepicker>

  export default {
    data() {
      return {
        value: ''
    methods: {
      dateDisabled(ymd, date) {
        // Disable weekends (Sunday = `0`, Saturday = `6`) and
        // disable days that fall on the 13th of the month
        const weekday = date.getDay()
        const day = date.getDate()
        // Return `true` if the date should be disabled
        return weekday === 0 || weekday === 6 || day === 13

<!-- b-form-datepicker-disabled-dates.vue -->

Note the min and max date constraints are evaluated first, before date-disabled-fn.

Validation states

<b-form-datepicker> supports invalid and valid styling via the boolean state prop. Setting state to boolean false will style the input as invalid, while setting it to boolean true will style it as valid. Setting state to null will not show any validation state styling (the default).

    <label for="datepicker-invalid">Choose a date (invalid style)</label>
    <b-form-datepicker id="datepicker-invalid" :state="false" class="mb-2"></b-form-datepicker>
    <label for="datepicker-valid">Choose a date (valid style)</label>
    <b-form-datepicker id="datepicker-valid" :state="true"></b-form-datepicker>

<!-- b-form-datepicker-invalid-valid.vue -->

Note that native browser validation is not available with <b-form-datepicker>.



The selected date button (background color) defaults to the 'primary' theme variant. You can change this to any of the Bootstrap v4 theme variant colors: 'secondary', 'success', 'danger', 'warning', 'info', etc, via the selected-variant prop.

Today's date will also be highlighted (text color) using the same variant as the selected date by default. To specify a different theme color to use for today's date, use the today-variant prop.

To disable highlighting of today's date altogether, set the no-highlight-today prop.

Control sizing

Fancy a smaller or larger <b-form-datepicker> control? Set the size prop to 'sm' for a smaller form control, or 'lg' for a larger form form control. Note this does not affect the size of the popup calendar dialog.

    <label for="datepicker-sm">Small date picker</label>
    <b-form-datepicker id="datepicker-sm" size="sm" local="en" class="mb-2"></b-form-datepicker>
    <label for="datepicker-lg">Large date picker</label>
    <b-form-datepicker id="datepicker-lg" size="lg" local="en"></b-form-datepicker>

<!-- b-form-datepicker-sizes.vue -->


Add custom placeholder text to the control, when no date is selected, via the placeholder prop. If a placeholder is not provided, the value of the label-no-date-selected prop is used.

    <label for="datepicker-placeholder">Date picker with placeholder</label>
    <b-form-datepicker id="datepicker-placeholder" placeholder="Choose a date" local="en"></b-form-datepicker>

<!-- b-form-datepicker-placeholder.vue -->

Optional controls

Add optional control buttons to the bottom of the calendar popup via the props today-button, reset-button and close-button.

  • The today button selects today's date
  • The reset button either clears the selected date, or sets the date to the value of the prop reset-value (if provided)
  • The close button closes the calendar popup

By default, clicking on the today or reset button will also close the calendar popup, unless the prop no-close-on-select is set.

    <label for="datepicker-buttons">Date picker with optional footer buttons</label>

<!-- b-form-datepicker-buttons.vue -->

The text for the optional buttons can be set via the label-today-button, label-reset-button, and the label-close-button props. Due to the limited width of the footer section, it is recommended to keep these labels short.

Use the dropdown props right, dropup, dropright, dropleft, no-flip, and offset to control the positioning of the popup calendar.

Refer to the <b-dropdown> documentation for details on the effects and usage of these props.

Dark mode

Want a fancy popup with a dark background instead of a light background? Set the dark prop to true to enable the dark background.


Internationalization of the date picker's calendar is provided via Intl.DateTimeFormat, except for labels applied to elements of the calendar control (aria-labels, selected status, and help text). You must provide your own translations for these labels. The available locales will be browser dependant (not all browsers support all locales)

By default <b-form-datepicker> will use the browser's default locale, but you can specify the locale (or locales) to use via the locale prop. The prop accepts either a single locale string, or an array of locale strings (listed in order of preferred locale).

The calendar starts the week on Sunday. This can be changed by setting the start-weekday prop to a number in the range of 0 to 6 where 0 represents Sunday, 1 for Monday, up to 6 for Saturday.

    <label for="example-locales">Locale:</label>
    <b-form-select id="example-locales" v-model="locale" :options="locales" class="mb-2"></b-form-select>

    <label for="example-weekdays">Start weekday:</label>
    <b-form-select id="example-weekdays" v-model="weekday" :options="weekdays" class="mb-2"></b-form-select>

    <label for="example-i18n-picker">Date picker:</label>
      v-bind="labels[locale] || {}"
     <p>Value: <b>'{{ value }}'</b></p>

  export default {
    data() {
      return {
        value: '',
        locale: 'en-US',
        locales: [
          { value: 'en-US', text: 'English US (en-US)' },
          { value: 'de', text: 'German (de)' },
          { value: 'ar-EG', text: 'Arabic Egyptian (ar-EG)' },
          { value: 'zh', text: 'Chinese (zh)' }
        weekday: 0,
        weekdays: [
          { value: 0, text: 'Sunday' },
          { value: 1, text: 'Monday' },
          { value: 6, text: 'Saturday' }
        labels: {
          de: {
            labelPrevYear: 'Vorheriges Jahr',
            labelPrevMonth: 'Vorheriger Monat',
            labelCurrentMonth: 'Aktueller Monat',
            labelNextMonth: 'Nächster Monat',
            labelNextYear: 'Nächstes Jahr',
            labelToday: 'Heute',
            labelSelected: 'Ausgewähltes Datum',
            labelNoDateSelected: 'Kein Datum gewählt',
            labelCalendar: 'Kalender',
            labelNav: 'Kalendernavigation',
            labelHelp: 'Mit den Pfeiltasten durch den Kalender navigieren'
          'ar-EG': {
            labelPrevYear: 'العام السابق',
            labelPrevMonth: 'الشهر السابق',
            labelCurrentMonth: 'الشهر الحالي',
            labelNextMonth: 'الشهر المقبل',
            labelNextYear: 'العام المقبل',
            labelToday: 'اليوم',
            labelSelected: 'التاريخ المحدد',
            labelNoDateSelected: 'لم يتم اختيار تاريخ',
            labelCalendar: 'التقويم',
            labelNav: 'الملاحة التقويم',
            labelHelp: 'استخدم مفاتيح المؤشر للتنقل في التواريخ'
          zh: {
            labelPrevYear: '上一年',
            labelPrevMonth: '上个月',
            labelCurrentMonth: '当前月份',
            labelNextMonth: '下个月',
            labelNextYear: '明年',
            labelToday: '今天',
            labelSelected: '选定日期',
            labelNoDateSelected: '未选择日期',
            labelCalendar: '日历',
            labelNav: '日历导航',
            labelHelp: '使用光标键浏览日期'

<!-- b-form-datepicker-i18n.vue -->

You can listen to for the context event to determine the locale and directionality that the calendar has resolved to.

Refer to the <b-calendar> documentation for additional details.


The popup calendar supports the same keyboard controls as <b-calendar>, along with the following:

  • ESC will close the popup calendar without selecting a date

When internationalizing the datepicker, it is important to also update the label-* props with appropriate translated strings, so that international screen reader users will hear the correct prompts and descriptions.

Refer to the <b-calendar> documentation for additional details.

Implementation notes

<b-form-datepicker> is based upon the components <b-calendar> and <b-dropdown>.

<b-form-datepicker> uses Bootstrap's margin, padding, border, and flex utility classes, along with button (btn-*) classes, and the form-control* (plus validation) classes.

BootstrapVue's Custom SCSS/CSS is also required for proper styling of the date picker and calendar.

See also

Component reference



Component aliases

<b-form-datepicker> can also be used via the following aliases:

  • <b-datepicker>

Note: component aliases are only available when importing all of BootstrapVue or using the component group plugin.


Property (Click to sort Ascending)TypeDefaultDescription
id StringUsed to set the 'id' attribute on the rendered content, and used as the base to generate any additional element IDs as needed
value v-model String or DateInitially selected date value. Accepts either a `YYYY-MM-DD` string or a `Date` object
value-as-date BooleanfalseReturns a `Date` object for the v-model instead of a `YYYY-MM-DD` string
reset-value String or DateWhen the optional `reset` button is clicked, the selected date will be set to this value. Default is to clear the selected value
placeholder StringText so show in the form control when no date is selected. Defaults to the `label-no-date-selected` prop value
size StringSet the size of the component's appearance. 'sm', 'md' (default), or 'lg'
min String or DateThe minimum date the calendar will show
max String or DateThe maximum date the calendar will show
disabled BooleanfalsePlaces the calendar in a non-interactive disabled state
readonly BooleanfalsePlaces the calendar in an interactive readonly state. Disables updating the v-model, while still allowing date navigation
required BooleanfalseWhen set, adds the `aria-required="true"` attribute on the component. Required validation needs to be handled by your application
name StringSets the value of the 'name' attribute on the form control
form StringID of the form that the form control belongs to. Sets the 'form' attribute on the control
state BooleanControls the validation state appearance of the component. 'true' for valid, 'false' for invalid', or 'null' for no validation state
date-disabled-fn FunctionSet to a function reference which returns `true` if the date is disabled, or `false` if the date should be enabled. See documentation for details
no-close-on-select BooleanfalseDisables closing the popup date picker when a date is clicked/selected
hide-header BooleanfalseWhen set, visually hides the selected date header
locale String or ArrayLocale (or locales) for the calendar to use. When passing an array of locales, the order of the locales is from most preferred to least preferred
start-weekday Number or String0Day of week to start the calendar. `0` for Sunday, `1` for Monday, `6` for Saturday, etc.
direction StringSet to the string 'rtl' or 'ltr' to explicitly force the calendar to render in right-to-left or left-ro-right (respectively) mode. Defaults to the resolved locale's directionality
selected-variant String'primary'Theme color variant to use for the selected date button
today-variant StringTheme color variant to use for highlighting todays date button. Defaults to the `variant` prop
no-highlight-today BooleanfalseDisabled the highlighting of todays date in the calendar
today-button BooleanfalseWhen set, shows the optional `select today` button
label-today-button String'Select today'Content for the optional `Select today` button
today-button-variant String'outline-primary'Button variant to use for the optional `select today` button
reset-button BooleanfalseWhen set, shows the optional `reset` button
label-reset-button String'Reset'Content for the optional `Reset` button
reset-button-variant String'outline-danger'Button variant to use for the optional `reset` button
close-button BooleanfalseWhen set, shows the optional close button
label-close-button String'Close'Content for the optional `Close` button
close-button-variant String'outline-secondary'Button variant to use for the optional `close` button
label-prev-year String'Previous year'Value of the `aria-label` and `title` attributes on the `Previous Year` navigation button
label-prev-month String'Previous month'Value of the `aria-label` and `title` attributes on the `Previous Month` navigation button
label-current-month String'Current month'Value of the `aria-label` and `title` attributes on the `Current Month` navigation button
label-next-month String'Next month'Value of the `aria-label` and `title` attributes on the `Next Month` navigation button
label-next-year String'Next year'Value of the `aria-label` and `title` attributes on the `Next Year` navigation button
label-today String'Today'Value of the `aria-label` attribute for the calendar grid date button to signify that the date is today's date
label-selected String'Selected date'Value of the `aria-label` attribute set on the calendar grid date button that is selected
label-no-date-selected String'No date selected'Label to use when no date is currently selected
label-calendar String'Calendar'Value of the `aria-label` and `role-description` attributes applied to the calendar grid
label-nav String'Calendar navigation'Value of the `aria-label` attribute on to the calendar navigation button wrapper
label-help String'Use cursor keys to navigate calendar dates'help text that appears at the bottom of the calendar grid
dark BooleanfalseWhen set, gives the popup calendar dialog a dark background
dropup BooleanfalseWhen set, positions the menu on the top of the button
dropright BooleanfalseWhen set, positions the menu to the right of the button
dropleft BooleanfalseWhen set, positions the menu to the left of the button
right BooleanfalseAlign the right edge of the menu with the right of the button
offset Number or String0Specify the number of pixels to shift the menu by. Negative values supported
no-flip BooleanfalsePrevent the menu from auto flipping positions
popper-opts AnyAdditional configuration to pass to Popper.js
boundary String or 'scrollParent'The boundary constraint of the menu: `'scrollParent'`, `'window'`, `'viewport'`, or a reference to an `HTMLElement`




  1. date - Either a string in the format of `YYYY-MM-DD` or a `Date` object (if `value-as-date` prop is `true`)
Emitted when updating the v-model
  1. context - The `b-calendar` context object. See the `b-calendar` documentaion for details
`b-calendar` context event. Emitted when the user changes the active date via date navigation buttons or cursor control

Importing individual components

You can import individual components into your project via the following named exports:

ComponentNamed ExportImport Path


import { BFormDatepicker } from 'bootstrap-vue'
Vue.component('b-form-datepicker', BFormDatepicker)

Importing as a Vue.js plugin

This plugin includes all of the above listed individual components. Plugins also include any component aliases.

Named ExportImport Path


import { FormDatepickerPlugin } from 'bootstrap-vue'