Skip to main content
Vuetify0 Logo
Theme
Mode
Palettes
Accessibility
Vuetify One
Sign in to Vuetify One

Access premium tools across the Vuetify ecosystem — Bin, Play, Studio, and more.

Not a subscriber? See what's included

TimePicker API

Segmented hour, minute, and optional second spinbuttons. A meridiem control appears in 12-hour mode, and a named field submits the 24-hour value.

Explore these related pages for additional context and usage patterns.

PageCategory
Time PickerForms
createTimePickerForms
Number FieldForms

TimePicker.Root

Props

namespace

string | undefined

Namespace shared with the field components.

Default: "v0:time-picker"

disabled

boolean | undefined

Ignore every edit, show the value as given, and never emit.

Default: false

readonly

boolean | undefined

Ignore every edit, show the value as given, and never emit.

hourCycle

any

h12 shows 1–12 and a meridiem. h23 shows 0–23.

Default: "h23"

seconds

boolean | undefined

Show the second field and include seconds in the value.

Default: false

hourStep

number | undefined

Hour interval. The hour moves on its multiples.

Default: 1

minuteStep

number | undefined

Minute interval. The minute moves on its multiples.

Default: 1

secondStep

number | undefined

Second interval. The second moves on its multiples.

Default: 1

min

string | null | undefined

Inclusive lower bound, HH:mm or HH:mm:ss.

Default: null

max

string | null | undefined

Inclusive upper bound, HH:mm or HH:mm:ss.

Default: null

name

string | undefined

Set it to submit the displayed time with a form.

form

string | undefined

Id of the form the hidden input belongs to, when it sits outside it.

required

boolean | undefined

Fail validation while a field is still empty. Root reads it once, at setup.

rules

any[] | undefined

Validation rules. Each receives the model value. Root reads them once, at setup.

Default: []

validateOn

any

When to validate. Focus moving between the fields is not a blur. Input is an edit, a value from outside, or the picker normalizing a value that has a validity, from a validation or from error / errorMessages. The picker reads a late-accepting parent's answer as a value from outside.

Default: "blur"

error

boolean | undefined

Force the invalid state, whatever the rules say.

Default: false

errorMessages

any

Error messages that come before the ones the rules produce.

formNamespace

string | undefined

Namespace of the parent Form to register with.

Default: "v0:form"

id

string | undefined

Id of the group element.

Default: useId()

ariaLabel

string | undefined

Accessible name for the group. Falls back to the locale catalog.

ariaLabelledby

string | undefined

Id of the element that labels the group. Replaces ariaLabel.

ariaDescribedby

string | undefined

Id of the element that describes the group.

modelValue

string | null | undefined

Default: null

Events

update:model-value

[value: string | null]

Slots

default

TimePickerRootSlotProps

TimePicker.Description

Props

id

string | undefined

Unique identifier. The component generates one when you pass none.

Default: useId()

namespace

string | undefined

Namespace for connecting to parent TimePicker.Root

Default: "v0:time-picker"

Slots

default

TimePickerDescriptionSlotProps

TimePicker.Error

Props

id

string | undefined

Unique identifier. The component generates one when you pass none.

Default: useId()

namespace

string | undefined

Namespace for connecting to parent TimePicker.Root

Default: "v0:time-picker"

Slots

default

TimePickerErrorSlotProps

TimePicker.HiddenInput

Props

namespace

string | undefined

Namespace for connecting to TimePicker.Root.

Default: "v0:time-picker"

TimePicker.Hour

Props

namespace

string | undefined

Namespace for connecting to TimePicker.Root.

Default: "v0:time-picker"

id

string | undefined

Id of the spinbutton. Defaults to the Root id plus the part name.

ariaLabel

string | undefined

Accessible name. Falls back to the locale catalog.

ariaLabelledby

string | undefined

Id of the element that labels the spinbutton. Replaces ariaLabel.

Slots

default

TimePickerHourSlotProps

TimePicker.Minute

Props

namespace

string | undefined

Namespace for connecting to TimePicker.Root.

Default: "v0:time-picker"

id

string | undefined

Id of the spinbutton. Defaults to the Root id plus the part name.

ariaLabel

string | undefined

Accessible name. Falls back to the locale catalog.

ariaLabelledby

string | undefined

Id of the element that labels the spinbutton. Replaces ariaLabel.

Slots

default

TimePickerMinuteSlotProps

TimePicker.Period

Props

namespace

string | undefined

Namespace for connecting to TimePicker.Root.

Default: "v0:time-picker"

id

string | undefined

Id of the spinbutton. Defaults to the Root id plus the part name.

ariaLabel

string | undefined

Accessible name. Falls back to the locale catalog.

ariaLabelledby

string | undefined

Id of the element that labels the spinbutton. Replaces ariaLabel.

Slots

default

TimePickerPeriodSlotProps

TimePicker.Second

Props

namespace

string | undefined

Namespace for connecting to TimePicker.Root.

Default: "v0:time-picker"

id

string | undefined

Id of the spinbutton. Defaults to the Root id plus the part name.

ariaLabel

string | undefined

Accessible name. Falls back to the locale catalog.

ariaLabelledby

string | undefined

Id of the element that labels the spinbutton. Replaces ariaLabel.

Slots

default

TimePickerSecondSlotProps
Was this page helpful?

© 2016-1970 Vuetify, LLC
Services
Ctrl+/