DOM Studio

Component

Time selector

<DomTimeSelector>

A typed time field with a popover list of selectable times. Stores HH:mm by default and can display 12-hour or 24-hour labels.

Playground

Try every prop live

Time selector playground

The input stores HH:mm by default. Use timeFormat for 12-hour labels, minuteStep for generated options, and min/max to constrain selection.

Type a time or choose one from the generated list.

Playground.vuevue
<script setup>
import { reactive } from 'vue';
import { DomTimeSelector } from '@getdom/studio/vue';

const data = reactive({
	  "modelValue": "09:30",
	  "id": "",
	  "name": "",
	  "label": "Meeting time",
	  "description": "Type a time or choose one from the generated list.",
	  "placeholder": "",
	  "required": false,
	  "disabled": false,
	  "readOnly": false,
	  "invalid": false,
	  "errors": [],
	  "visible": true,
	  "validators": [],
	  "validateOnBlur": true,
	  "chrome": "field",
	  "timeFormat": "24h",
	  "minuteStep": 15,
	  "min": "08:00",
	  "max": "18:00",
	  "options": [],
	  "showSeconds": false,
	  "nativeInput": true,
	  "registerField": true,
	  "popoverProps": {}
	});
</script>

<template>
	<DomTimeSelector
		v-bind="data"
		@update:modelValue="data.modelValue = $event"
	/>
</template>

Demo

Generated business hours

Generate a selectable list from min, max, and minuteStep while still accepting typed times.

Type a time or choose one from the generated list.

Stored value: 09:30

MeetingTime.vuevue
<script setup>
import { ref } from 'vue';
import { DomTimeSelector } from '../../../lib/vue';

const time = ref('09:30');
</script>

<template>
	<div class="max-w-sm space-y-4">
		<DomTimeSelector
			v-model="time"
			name="meeting_time"
			label="Meeting time"
			description="Type a time or choose one from the generated list."
			:min="'08:00'"
			:max="'18:00'"
			:minute-step="15"
		/>

		<p class="rounded-xl border border-border bg-secondary px-3 py-2 text-sm text-muted-fg">
			Stored value:
			<code class="font-mono text-canvas-fg">{{ time || 'empty' }}</code>
		</p>
	</div>
</template>

Demo

12-hour labels

Display 12-hour labels with AM and PM while storing the canonical HH:mm value.

Display options in 12-hour time while storing HH:mm.

Stored value: 14:30

TwelveHourTime.vuevue
<script setup>
import { ref } from 'vue';
import { DomTimeSelector } from '../../../lib/vue';

const time = ref('14:30');
</script>

<template>
	<div class="max-w-sm space-y-4">
		<DomTimeSelector
			v-model="time"
			name="handoff_time"
			label="Handoff time"
			description="Display options in 12-hour time while storing HH:mm."
			time-format="12h"
			:min="'09:00'"
			:max="'17:00'"
			:minute-step="30"
		/>

		<p class="rounded-xl border border-border bg-secondary px-3 py-2 text-sm text-muted-fg">
			Stored value:
			<code class="font-mono text-canvas-fg">{{ time || 'empty' }}</code>
		</p>
	</div>
</template>

Reference

Props

Control props

NameTypeTSDefaultDescription
modelValuestringstring''Selected time as HH:mm, or HH:mm:ss when showSeconds is enabled.
timeFormat'24h' | '12h'string'24h'How times are displayed in the input and option list.
minuteStepnumbernumber15Minute interval used to generate selectable options.
minstringstring''Minimum selectable time as HH:mm or HH:mm:ss.
maxstringstring''Maximum selectable time as HH:mm or HH:mm:ss.
options
[
	{
		value: "09:30",
		label: "9:30 AM",
		disabled: false,
	}
]
arrayArray<OptionsItem
type OptionsItem = {
	value?: string; // Value
	label?: string; // Label
	disabled?: boolean; // Disabled
};
>		[]Optional custom time options. Use strings such as 09:30 or records with value, label, and disabled.
showSecondsbooleanbooleanfalseStore and display seconds in addition to hours and minutes.
nativeInputbooleanbooleantrueInclude the native input name for HTML form submission.
registerFieldbooleanbooleantrueRegister with a parent form. Disable when composing this inside another form control.
popoverPropsobjectRecord<string, unknown>{}Props passed to the inner DomPopover. Time selector defaults position to bottom-end, max width to 18rem, padding to p-2, and arrow to true.

Field props

NameTypeTSDefaultDescription
idstringstring''Optional ID override. By default parent forms derive the input ID from the field path using underscores.
namestringstring''Local field name. Parent forms derive the full field path and native HTML name from the form hierarchy.
labelstringstring''Visible field label.
descriptionstringstring''Optional helper copy below the field.
placeholderstringstring''Placeholder shown when the control is empty.
requiredbooleanbooleanfalseMark the field as required.
disabledbooleanbooleanfalseDisable field interaction.
readOnlybooleanbooleanfalseShow the value but prevent editing.
invalidbooleanbooleanfalseMark the field invalid.
errors
[
	{
		name: "Validation name",
		message: "Error message",
	}
]
array | object | stringArray<ErrorsItem
type ErrorsItem = {
	name?: string; // Name
	message?: string; // Message
};
>		[]Validation errors for this field.
visiblebooleanbooleantrueShow or hide the field.
validatorsarrayArray<unknown>[]Validators attached to this field. Use functions in Vue code, or serializable records such as { name: "minLength", props: { min: 2 } } in generated schemas.
validateOnBlurbooleanbooleantrueRun validators when the field loses focus.
chrome'field' | falsestring'field'Render default field chrome, or false to render only the control while keeping form state wiring.

Auto-generated from Time selector.props and inline _edit hints.

Events

NamePayloadDescription
@update:modelValueHH:mmFired when a valid time is committed or selected.
@changeHH:mmFired when a valid time is committed.
@invalid-timestringFired when typed text cannot be parsed or is outside the allowed range.
@focusFocusEventFired when the text input receives focus.
@blurFocusEventFired when the text input loses focus.

Names auto-detected from defineEmits and source emit() calls; payload and description from __doc.events when present.

Keyboard

  • Alt + ArrowDownOpen the time list.
  • EnterCommit the typed time when it is valid.
  • EscClose the popover.
  • TabMove through generated time options when the list is open.