DEVELOPER REFERENCE · v4.0.0

TemporalPicker API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

TemporalPicker17 props3 callbacks0 methods

Props17

TemporalPicker props
Name	Type	Description
`value`Required	`TemporalControlValue`Inspect type	Value to display or edit. The declared type identifies the supported representation; change callbacks describe how edited values are emitted.
`kind`Optional	`LocalDateControlKind \| undefined`Inspect type	Date/time value kind handled by the temporal control.
`dateInput`Optional	`boolean \| DateInputOptions \| undefined`Inspect type	Typed date entry is enabled by default; false retains calendar-only controls.
`selection`Optional	`"multiple" \| "range" \| "single" \| undefined`	Current selected date/range, or the selection mode where the declared type is a mode string.
`calendar`Optional	`TemporalCalendarOptions \| undefined`Inspect type	Calendar presentation, navigation and selection options for the temporal picker.
`required`Optional	`boolean \| undefined`	Requires a non-empty value or selection before the edit can be accepted.
`minTime`Optional	`string \| undefined`	Earliest permitted time, expressed in the control time format.
`maxTime`Optional	`string \| undefined`	Latest permitted time, expressed in the control time format.
`timeStep`Optional	`number \| undefined`	Step between selectable times in seconds; defaults to 60 for minute precision or 1 for second precision.
`precision`Optional	`"minute" \| "second" \| undefined`	Includes minutes only or also exposes seconds.
`timeFormat`Optional	`"locale" \| "12h" \| "24h" \| undefined`	Uses locale-default, explicit 12-hour or explicit 24-hour time presentation.
`text`Optional	`Partial<TemporalPickerText> \| undefined`Inspect type	Display text or localized text overrides; expand the type when this prop accepts an object.
`actions`Optional	`Partial<EditorActionText> \| undefined`Inspect type	Actions rendered by this component, or action-label overrides for editor fields; expand the declared type.
`classNames`Optional	`{ endpoints?: string; } \| undefined`Inspect type	Endpoint-only adjustment, for the existing Timeline end-arrow interaction.
`endpoint`Optional	`"from" \| "to" \| undefined`	Range endpoint being edited, from or to.
`autoApply`Optional	`boolean \| undefined`	Apply completed edits automatically. Set false to require explicit Apply.
`showActions`Optional	`boolean \| undefined`	Show Apply/Cancel buttons. Defaults to true only when autoApply is false.

Events and callbacks3

TemporalPicker events and callbacks
Name	Type	Description
`onChange`Required	`(value: TemporalControlValue) => void`Inspect type	Receives the new value when the user changes the control. Update the corresponding value prop for controlled use.
`onValidityChange`Optional	`((valid: boolean) => void) \| undefined`Inspect type	Receives true or false when the validity of the current input changes.
`onSelectionComplete`Optional	`((value: TemporalControlValue) => void) \| undefined`Inspect type	Complete calendar selection, distinct from an in-progress keyboard draft.

Methods0

No component-specific imperative methods. Use props and callbacks to control this component.