Vue Date Range Input Component API

Date Range Input API

CoreUI PRO
This component is part of CoreUI PRO – a powerful UI library with over 250 components and 25+ templates, designed to help you build modern, responsive apps faster. Fully compatible with Angular, Bootstrap, React.js, and Vue.js.

Explore the API reference for the Vue Date Range Input component and discover how to effectively utilize its props for customization.

On this page

CDateRangeInput

jsx
import { CDateRangeInput } from '@coreui/vue'

Props

PropertyDefaultType
ariaDayLabel'Day'string

The aria-label of the day section.

ariaEndLabel'End date'string

The accessible name of the end field, used when it has no floating label.

ariaHourLabel'Hour'string

The aria-label of the hour section.

ariaMeridiemLabel'AM/PM'string

The aria-label of the meridiem section.

ariaMinuteLabel'Minute'string

The aria-label of the minute section.

ariaMonthLabel'Month'string

The aria-label of the month section.

ariaQuarterLabel'Quarter'string

The aria-label of the quarter section.

ariaSecondLabel'Second'string

The aria-label of the second section.

ariaStartLabel'Start date'string

The accessible name of the start field, used when it has no floating label.

ariaWeekLabel'Week'string

The aria-label of the week section.

ariaYearLabel'Year'string

The aria-label of the year section.

autoFocus-boolean

Focus the first section of the start date right after mounting.

dayPlaceholder-string

Replaces the DD the day section shows while it is empty.

disabled-boolean

Toggle the disabled state for both ends.

disabledDatesundefinedDisabledDate, DisabledDate[]

Specify the list of dates that cannot be selected in either end. It can be a single Date, an [start, end] range, a matcher function, or an array of these.

endDateundefinedDate, string, null

The end date — a Date or a date string. Passed one-way it seeds the field; bound with v-model:end-date it follows your state.

endFloatingLabel-string

The floating label of the end field. The text is also that field's accessible name.

endName-string

Name of the value input carrying the end date. Without it the end date is not submitted with the form.

feedback-string

Provide valuable, actionable feedback to your users with HTML5 form validation feedback.

feedbackInvalid-string

Provide valuable, actionable invalid feedback when using standard HTML form validation which applied validationState="invalid".

feedbackValid-string

Provide valuable, actionable valid feedback when using standard HTML form validation which applied validationState="valid".

floatingClassName-string

A string of all className you want applied to the floating label wrapper.

floatingLabel-string

Wrap the whole range in a floating label.

floatingLabelAlways6.0.0+-boolean

Keeps the floating label floated and the placeholder visible while the field is empty.

formatundefinedstring, ((locale: string) => DateSection[])

The mask layout for both ends. A string is parsed as dayjs/moment or date-fns/luxon format tokens, a function receives the locale and returns the section layout, and undefined derives the layout from the locale.

hourPlaceholder-string

Replaces the HH (hh on a 12-hour clock) the hour section shows while it is empty.

id-string

The id attribute of the frame.

inputDateParseundefined(value: string) => Date, null

Custom function to parse text pasted into either end into a Date object, e.g. with an external date library.

label-string

Add a caption for a component.

locale'default'string

Sets the default locale for both ends. If not set, it is inherited from the browser.

maxDateundefinedDate, string, null

Latest date either end can hold.

meridiemPlaceholder-string

Replaces the AM the meridiem section shows while it is empty.

minDateundefinedDate, string, null

Earliest date either end can hold.

minutePlaceholder-string

Replaces the mm the minute section shows while it is empty.

monthNamesundefinedstring[]

Twelve custom month names for text month sections (MMM/MMMM), overriding the locale-derived, date-context grammatical form.

monthPlaceholder-string

Replaces the MM the month section shows while it is empty.

quarterPlaceholder-string

Replaces the Q the quarter section shows while it is empty.

readOnly-boolean

Make both ends focusable but non-editable.

required-boolean

When present, it specifies that both ends must be filled out before submitting the form.

secondPlaceholder-string

Replaces the ss the second section shows while it is empty.

seconds-boolean

Include a seconds section in the locale-derived layout of type="datetime". Both ends follow.

sizeundefinedstring

Size the component small or large - both ends follow.

startDateundefinedDate, string, null

The start date — a Date or a date string. Passed one-way it seeds the field; bound with v-model:start-date it follows your state.

startFloatingLabel-string

The floating label of the start field. The text is also that field's accessible name.

startName-string

Name of the value input carrying the start date. Without it the start date is not submitted with the form.

text-string

Add helper text to the component.

tooltipFeedback-boolean

Display validation feedback in a styled tooltip.

type'date'string

Which sections the locale-derived layout carries. A format names the sections itself and overrides this. Both ends follow.

validationState-string

The validation state, rendered as the is-{state} class on the frame; 'invalid' also sets aria-invalid on the sections of both ends and blocks the submit. An end before the start and an end the limits reject mark the frame invalid on their own. The user's next change of either end emits update:validationState with undefined.

weekPlaceholder-string

Replaces the WW the week section shows while it is empty.

yearPlaceholder-string

Replaces the YYYY the year section shows while it is empty.

Events

Event name
end-date-change

Callback fired when the end date changes.

  • date Date | null — date object
start-date-change

Callback fired when the start date changes.

  • date Date | null — date object
update:endDate

Emit the new end date to support the v-model:end-date binding.

  • date Date | null — date object
update:startDate

Emit the new start date to support the v-model:start-date binding.

  • date Date | null — date object
update:validationState

Event occurs with undefined when the user changes either end, or the form is reset, while validationState is set. A given state is a verdict on the range it was given for; bind it with v-model:validation-state to drop it and let the browser's own validation show again.