Skip to content

TimeField

Overview

A segment-based time input built on Reka UI's TimeFieldRoot. Users tab through individual hour, minute, and optional second segments. Supports 12-hour and 24-hour formats via the hourCycle prop.

Theme entry: TimeField

Props

NameTypeRequiredDefaultDescription
themeOverrideString|Object|ArraynullA partial theme object merged with the component's default theme; accepts a class string, class array, or theme object.
classimport('vue').HTMLAttributes['class']undefinedAdditional CSS classes to apply to the root element.
modelValueobjectundefinedThe controlled time value. Can be bound as v-model.
defaultValueobjectundefinedThe default value when uncontrolled.
placeholderobjectundefinedThe placeholder time used to determine initial display when no value is set.
defaultPlaceholderobjectundefinedThe default placeholder time.
granularitystringundefinedThe granularity of the time field ("hour", "minute", or "second").
hourCyclenumberundefinedThe hour cycle for time formatting (12 or 24).
stepobjectundefinedThe stepping interval for the time segments.
stepSnappingbooleanundefinedWhether to enforce snapping the value to the nearest step increment.
hideTimeZonebooleanundefinedWhether to hide the time zone segment.
maxValueobjectundefinedThe maximum selectable time.
minValueobjectundefinedThe minimum selectable time.
localestringundefinedThe locale used for formatting times.
disabledbooleanundefinedWhen true, prevents interaction with the time field.
readonlybooleanundefinedWhen true, the field is read-only.
idstringundefinedThe id of the underlying element.
namestringundefinedThe name submitted with form data.
requiredbooleanfalseWhen true, the field is required.
sizestring"default"Size variant of the segment field shell.
asstring|objectundefinedThe element or component to render as.
asChildbooleanfalseWhen true, merges props onto the child element instead of rendering a wrapper.

Slots

default

Scoped slot.

Events

NameDescription
update:modelValueEmitted when the value changes.
update:placeholderEmitted when the placeholder date changes.

Full event reference

Source

client/lib/controls/time-field/TimeField.vue

Documents matching: server v3.0.0a1.post1client v3.0.0-alpha.2