Skip to components
DEVELOPER REFERENCE · v4.0.0

DateTimeField API

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

DateTimeField8 props1 callbacks0 methods

Props8

DateTimeField props
NameTypeDescription
kindOptional
LocalDateControlKind | undefinedInspect type
Date/time value kind handled by the temporal control.
valueRequiredstringValue to display or edit. The declared type identifies the supported representation; change callbacks describe how edited values are emitted.
requiredOptionalboolean | undefinedRequires a non-empty value or selection before the edit can be accepted.
disabledOptionalboolean | undefinedDisables user interaction with the control.
readOnlyOptionalboolean | undefinedDisplays the current value while preventing user edits.
pickerOptional
Omit<TemporalPickerOptions, "selection" | "kind"> | undefinedInspect type
Configuration passed to the popup temporal picker.
formatValueOptional
((value: string) => string) | undefinedInspect type
Existing product text adapters can keep their custom display/parser.
parseValueOptional
((text: string) => string | undefined) | undefinedInspect type
Converts typed text into a valid field value; return undefined when parsing fails.

Events and callbacks1

DateTimeField events and callbacks
NameTypeDescription
onValueChangeOptional
((value: string) => void) | undefinedInspect type
Receives the updated input value. Store it in application state and pass it back through value.

Methods0

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

Inherited HTML props and events344