UseTimeInputResult
Properties
Section titled “Properties”clear: () => void;Returns
Section titled “Returns”void
clearSegment
Section titled “clearSegment”clearSegment: (segment) => void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
segment | TimeSegment |
Returns
Section titled “Returns”void
complete
Section titled “complete”complete: boolean;dayPeriods
Section titled “dayPeriods”dayPeriods: [string, string];The localised AM and PM words.
disabled
Section titled “disabled”disabled: boolean;displayValue
Section titled “displayValue”displayValue: (segment) => number | null;What a segment currently displays as a number, or null when empty.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
segment | TimeSegment |
Returns
Section titled “Returns”number | null
focused
Section titled “focused”focused: | TimeSegment | null;The segment that currently has focus.
focusSegment
Section titled “focusSegment”focusSegment: (segment) => void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
segment | TimeSegment |
Returns
Section titled “Returns”void
handleBlur
Section titled “handleBlur”handleBlur: (event) => void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
event | FocusEvent<HTMLElement> |
Returns
Section titled “Returns”void
handleSegmentFocus
Section titled “handleSegmentFocus”handleSegmentFocus: (segment, event) => void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
segment | TimeSegment |
event | FocusEvent<HTMLElement> |
Returns
Section titled “Returns”void
hour12
Section titled “hour12”hour12: boolean;True when the field shows a 1–12 hour and a day period.
ids: object & Record<TimeSegment, string>;Type Declaration
Section titled “Type Declaration”group: string;hidden
Section titled “hidden”hidden: string;max: string | undefined;min: string | undefined;moveFocus
Section titled “moveFocus”moveFocus: (from, delta) => void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
from | TimeSegment |
delta | number |
Returns
Section titled “Returns”void
order: TimeSegment[];outOfRange
Section titled “outOfRange”outOfRange: boolean;Complete, but outside min/max.
parts: TimeParts;What is currently typed. hour is always 0–23, whatever the field shows.
pieces
Section titled “pieces”pieces: TimePiece[];The segments and separators for the locale, in display order.
rangeFor
Section titled “rangeFor”rangeFor: (segment) => object;Inclusive bounds for one segment.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
segment | TimeSegment |
Returns
Section titled “Returns”object
max: number;min: number;readOnly
Section titled “readOnly”readOnly: boolean;segmentRefs
Section titled “segmentRefs”segmentRefs: object;Structural rather than RefObject: in @types/react 18 RefObject.current
is readonly, in 19 it is mutable. Declaring the shape keeps this assignable
under both, which matters because react >= 18 is a peer.
current
Section titled “current”current: Partial<Record<TimeSegment, HTMLElement | null>>;setSegment
Section titled “setSegment”setSegment: (segment, next) => void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
segment | TimeSegment |
next | number | null |
Returns
Section titled “Returns”void
step: (segment, delta) => void;Arrow-key stepping, wrapping at the ends.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
segment | TimeSegment |
delta | number |
Returns
Section titled “Returns”void
typeDigit
Section titled “typeDigit”typeDigit: (segment, digit) => void;Feed one typed digit into a segment; auto-advances when it cannot take more.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
segment | TimeSegment |
digit | string |
Returns
Section titled “Returns”void
typeLetter
Section titled “typeLetter”typeLetter: (segment, key) => boolean;a picks AM, p picks PM. Returns false when the key means nothing here.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
segment | TimeSegment |
key | string |
Returns
Section titled “Returns”boolean
value: string | null;HH:mm[:ss] when every needed segment is filled, else null.