Back to Vuetify

Date inputs

packages/docs/src/pages/en/components/date-inputs.md

4.0.72.8 KB
Original Source

Date inputs

The v-date-input component combines a text field with a date picker. It is meant to be a direct replacement for a standard date input.

<PageFeatures />

Installation

Labs components require manual import and registration with the Vuetify instance.

js
import { VDateInput } from 'vuetify/labs/VDateInput'

export default createVuetify({
  components: {
    VDateInput,
  },
})

Usage

At its core, the v-date-input component is a basic container that extends v-text-field.

<ExamplesUsage name="v-date-input" /> <PromotedEntry />

API

ComponentDescription
v-date-inputPrimary component
v-date-pickerDate picker component
v-text-fieldText field component
<ApiInline hide-links />

Guide

The v-date-input component is a replacement for the standard date input. It provides a clean interface for selecting dates and shows detailed selection information.

::: tip

Use the built in parseISO and toISO methods available as part of the date composable to format and parse the date input. Internally, v-date-input transforms the model into a plain JS Date object.

:::

Props

The v-date-input component extends the v-text-field and v-date-picker component; and supports all of their props.

Model

The default model value is a Date object, but is displayed as formatted text in the input..

<ExamplesExample file="v-date-input/prop-model" />

Multiple

Using the multiple prop, the default model value is an empty array.

<ExamplesExample file="v-date-input/prop-multiple" />

Range

Using the multiple prop with a value of range, select 2 dates to select them and all the dates between them.

<ExamplesExample file="v-date-input/prop-multiple-range" />

::: tip

On mobile devices, when the menu is open, clicking the input a second time will enable editing mode.

:::

Calendar icon

You can move the calendar icon within the input or entirely by utilizing the prepend-icon and prepend-inner-icon properties.

<ExamplesExample file="v-date-input/prop-prepend-icon" />

Input format

You can use the input-format prop to change the displayed format of the date in the input. This will make the field expect the same format when typing and pasting values.

<ExamplesExample file="v-date-input/prop-input-format" />

Examples

The following are a collection of examples that demonstrate more advanced and real world use of the v-date-input component.

Passenger

In this example, the v-date-input component is used to select a date of birth.

<ExamplesExample file="v-date-input/misc-passenger" />