@antadesign/anta
    Preparing search index...

    Interface InputTimePropsUnreviewed

    Common props for JSX component wrappers.

    interface InputTimeProps {
        children?: ReactNode;
        label?: ReactNode;
        hint?: ReactNode;
        status?: "neutral" | "brand" | "info" | "success" | "warning" | "critical";
        statusIcon?: string & {} | false | (keyof IconShapes);
        tone?: string;
        size?: "small" | "medium" | "large";
        value?: string;
        defaultValue?: string;
        locale?: string;
        hour12?: boolean;
        min?: string;
        max?: string;
        name?: string;
        disabled?: boolean;
        readOnly?: boolean;
        required?: boolean;
        icon?: false | (keyof IconShapes);
        clearable?: boolean;
        dimActions?: boolean;
        trailing?: ReactNode;
        round?: boolean | number | string;
        autoFocus?: boolean;
        onValueChange?: (event: any, attrs: InputTimeChangeAttrs) => void;
        onClearClick?: (e: CustomEvent) => void;
        onClearInput?: (e: CustomEvent) => void;
        onFocus?: (e: any) => void;
        onBlur?: (e: any) => void;
        className?: string;
        style?: CSSProperties;
        id?: string;
        title?: string;
        slot?: string;
        tabIndex?: number;
        key?: string | number | null;
        onClick?: (e: any) => void;
        onDoubleClick?: (e: any) => void;
        onAuxClick?: (e: any) => void;
        onContextMenu?: (e: any) => void;
        onMouseDown?: (e: any) => void;
        onMouseUp?: (e: any) => void;
        onMouseEnter?: (e: any) => void;
        onMouseLeave?: (e: any) => void;
        onMouseMove?: (e: any) => void;
        onMouseOver?: (e: any) => void;
        onMouseOut?: (e: any) => void;
        onPointerDown?: (e: any) => void;
        onPointerUp?: (e: any) => void;
        onPointerMove?: (e: any) => void;
        onPointerEnter?: (e: any) => void;
        onPointerLeave?: (e: any) => void;
        onPointerOver?: (e: any) => void;
        onPointerOut?: (e: any) => void;
        onPointerCancel?: (e: any) => void;
        onGotPointerCapture?: (e: any) => void;
        onLostPointerCapture?: (e: any) => void;
        onTouchStart?: (e: any) => void;
        onTouchEnd?: (e: any) => void;
        onTouchMove?: (e: any) => void;
        onTouchCancel?: (e: any) => void;
        onKeyDown?: (e: any) => void;
        onKeyUp?: (e: any) => void;
        onChange?: (e: any) => void;
        onInput?: (e: any) => void;
        onBeforeInput?: (e: any) => void;
        onInvalid?: (e: any) => void;
        onReset?: (e: any) => void;
        onSubmit?: (e: any) => void;
        onSelect?: (e: any) => void;
        onCopy?: (e: any) => void;
        onCut?: (e: any) => void;
        onPaste?: (e: any) => void;
        onCompositionStart?: (e: any) => void;
        onCompositionUpdate?: (e: any) => void;
        onCompositionEnd?: (e: any) => void;
        onDrag?: (e: any) => void;
        onDragStart?: (e: any) => void;
        onDragEnd?: (e: any) => void;
        onDragEnter?: (e: any) => void;
        onDragLeave?: (e: any) => void;
        onDragOver?: (e: any) => void;
        onDrop?: (e: any) => void;
        onScroll?: (e: any) => void;
        onWheel?: (e: any) => void;
        onAnimationStart?: (e: any) => void;
        onAnimationEnd?: (e: any) => void;
        onAnimationIteration?: (e: any) => void;
        onTransitionEnd?: (e: any) => void;
        onLoad?: (e: any) => void;
        onError?: (e: any) => void;
        onAbort?: (e: any) => void;
        onToggle?: (e: any) => void;
        onBeforeToggle?: (e: any) => void;
        onCanPlay?: (e: any) => void;
        onCanPlayThrough?: (e: any) => void;
        onDurationChange?: (e: any) => void;
        onEmptied?: (e: any) => void;
        onEnded?: (e: any) => void;
        onLoadedData?: (e: any) => void;
        onLoadedMetadata?: (e: any) => void;
        onLoadStart?: (e: any) => void;
        onPause?: (e: any) => void;
        onPlay?: (e: any) => void;
        onPlaying?: (e: any) => void;
        onProgress?: (e: any) => void;
        onRateChange?: (e: any) => void;
        onSeeked?: (e: any) => void;
        onSeeking?: (e: any) => void;
        onStalled?: (e: any) => void;
        onSuspend?: (e: any) => void;
        onTimeUpdate?: (e: any) => void;
        onVolumeChange?: (e: any) => void;
        onWaiting?: (e: any) => void;
        [key: `data-${string}`]: unknown;
        [key: `aria-${string}`]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: `data-${string}`]: unknown

      Any data-* attribute is forwarded to the rendered element.

    • [key: `aria-${string}`]: unknown

      Any aria-* attribute is forwarded to the rendered element.

    Index
    children? label? hint? status? statusIcon? tone? size? value? defaultValue? locale? hour12? min? max? name? disabled? readOnly? required? icon? clearable? dimActions? trailing? round? autoFocus? onValueChange? onClearClick? onClearInput? onFocus? onBlur? className? style? id? title? slot? tabIndex? key? onClick? onDoubleClick? onAuxClick? onContextMenu? onMouseDown? onMouseUp? onMouseEnter? onMouseLeave? onMouseMove? onMouseOver? onMouseOut? onPointerDown? onPointerUp? onPointerMove? onPointerEnter? onPointerLeave? onPointerOver? onPointerOut? onPointerCancel? onGotPointerCapture? onLostPointerCapture? onTouchStart? onTouchEnd? onTouchMove? onTouchCancel? onKeyDown? onKeyUp? onChange? onInput? onBeforeInput? onInvalid? onReset? onSubmit? onSelect? onCopy? onCut? onPaste? onCompositionStart? onCompositionUpdate? onCompositionEnd? onDrag? onDragStart? onDragEnd? onDragEnter? onDragLeave? onDragOver? onDrop? onScroll? onWheel? onAnimationStart? onAnimationEnd? onAnimationIteration? onTransitionEnd? onLoad? onError? onAbort? onToggle? onBeforeToggle? onCanPlay? onCanPlayThrough? onDurationChange? onEmptied? onEnded? onLoadedData? onLoadedMetadata? onLoadStart? onPause? onPlay? onPlaying? onProgress? onRateChange? onSeeked? onSeeking? onStalled? onSuspend? onTimeUpdate? onVolumeChange? onWaiting?
    children?: ReactNode

    Extra content rendered under the field, above the hint (a no-box child like a <Tooltip> takes no space and anchors to the field).

    label?: ReactNode

    Field label, shown above the control and used as the segment group's accessible name.

    hint?: ReactNode

    Message below the field. status recolors it and prefixes a glyph.

    status?: "neutral" | "brand" | "info" | "success" | "warning" | "critical"

    Validation / feedback tone. Only critical marks the field invalid; the others are advisory. Omit (or neutral) for a plain field.

    statusIcon?: string & {} | false | (keyof IconShapes)

    Glyph before the hint when status is set (per-status default; pass a shape to override, or false to drop it).

    tone?: string

    Custom accent color — any literal CSS color tints the resting + hover border (focus ring stays --focus-ring); status overrides for validation.

    size?: "small" | "medium" | "large"

    Size variant. small=24px, medium=28px, large=32px tall.

    medium
    value?: string

    Controlled value — 24-hour "HH:mm". Pair with onValueChange. Reset and restoration preserve it; releasing control retains the current time.

    defaultValue?: string

    Initial value for the uncontrolled case (24-hour "HH:mm").

    locale?: string

    BCP-47 locale driving the clock (12h vs 24h), segment order, separator, and the AM/PM text.

    navigator.language
    hour12?: boolean

    Force the clock: true = 12-hour (AM/PM), false = 24-hour. Omit to follow the locale.

    min?: string

    Earliest allowed time, 24-hour "HH:mm". A complete value below it is clamped up (on step / blur) and flagged rangeUnderflow for form validity.

    max?: string

    Latest allowed time, 24-hour "HH:mm". A complete value above it is clamped down (on step / blur) and flagged rangeOverflow.

    name?: string

    Form field name — the 24-hour value submits under this key.

    disabled?: boolean

    Disable the field.

    readOnly?: boolean

    Keep the time selectable and focusable while preventing edits. Blur emits change only if an edit was pending when the field became read-only.

    required?: boolean

    Mark the field required (drives native validity).

    icon?: false | (keyof IconShapes)

    Leading icon at the start of the field — the clock affordance. Pass another shape to change it, or false to drop it.

    clock
    clearable?: boolean

    Show a clear button once the field has a value.

    dimActions?: boolean

    Dim the trailing adornments at rest; they brighten on hover / focus.

    trailing?: ReactNode

    Content pinned to the end of the field (after the clear button).

    round?: boolean | number | string

    Fully-round the field, or a custom radius (number px / CSS length).

    autoFocus?: boolean

    Focus this field when its containing Dialog opens.

    onValueChange?: (event: any, attrs: InputTimeChangeAttrs) => void

    Fires on every edit (input), with the native event + an attrs snapshot (value, name, empty, valid, validationMessage). Also fires on change (blur) and on clear. Read-only blur is silent unless committing an edit made before the field became read-only.

    onClearClick?: (e: CustomEvent) => void

    Fires before clearing. Call preventDefault() synchronously to keep the value.

    onClearInput?: (e: CustomEvent) => void

    Fires after the built-in clear button has cleared the field.

    onFocus?: (e: any) => void

    Fires when the field gains focus.

    onBlur?: (e: any) => void

    Fires when the field loses focus.

    className?: string

    Adds CSS classes to the root element and preserves its existing classes.

    style?: CSSProperties

    Inline CSS styles on the root element.

    id?: string

    HTML id attribute.

    title?: string

    HTML title attribute, shown as a browser tooltip on hover.

    slot?: string

    Named slot in a parent web component, such as slot="header" in a <Dialog>.

    tabIndex?: number

    Tab order. Set to -1 to skip the element when tabbing.

    key?: string | number | null

    React/Preact reconciliation key when rendered inside a list. Consumed by the JSX runtime (not forwarded as a DOM attribute).

    onClick?: (e: any) => void
    onDoubleClick?: (e: any) => void
    onAuxClick?: (e: any) => void
    onContextMenu?: (e: any) => void
    onMouseDown?: (e: any) => void
    onMouseUp?: (e: any) => void
    onMouseEnter?: (e: any) => void
    onMouseLeave?: (e: any) => void
    onMouseMove?: (e: any) => void
    onMouseOver?: (e: any) => void
    onMouseOut?: (e: any) => void
    onPointerDown?: (e: any) => void
    onPointerUp?: (e: any) => void
    onPointerMove?: (e: any) => void
    onPointerEnter?: (e: any) => void
    onPointerLeave?: (e: any) => void
    onPointerOver?: (e: any) => void
    onPointerOut?: (e: any) => void
    onPointerCancel?: (e: any) => void
    onGotPointerCapture?: (e: any) => void
    onLostPointerCapture?: (e: any) => void
    onTouchStart?: (e: any) => void
    onTouchEnd?: (e: any) => void
    onTouchMove?: (e: any) => void
    onTouchCancel?: (e: any) => void
    onKeyDown?: (e: any) => void
    onKeyUp?: (e: any) => void
    onChange?: (e: any) => void
    onInput?: (e: any) => void
    onBeforeInput?: (e: any) => void
    onInvalid?: (e: any) => void
    onReset?: (e: any) => void
    onSubmit?: (e: any) => void
    onSelect?: (e: any) => void
    onCopy?: (e: any) => void
    onCut?: (e: any) => void
    onPaste?: (e: any) => void
    onCompositionStart?: (e: any) => void
    onCompositionUpdate?: (e: any) => void
    onCompositionEnd?: (e: any) => void
    onDrag?: (e: any) => void
    onDragStart?: (e: any) => void
    onDragEnd?: (e: any) => void
    onDragEnter?: (e: any) => void
    onDragLeave?: (e: any) => void
    onDragOver?: (e: any) => void
    onDrop?: (e: any) => void
    onScroll?: (e: any) => void
    onWheel?: (e: any) => void
    onAnimationStart?: (e: any) => void
    onAnimationEnd?: (e: any) => void
    onAnimationIteration?: (e: any) => void
    onTransitionEnd?: (e: any) => void
    onLoad?: (e: any) => void
    onError?: (e: any) => void
    onAbort?: (e: any) => void
    onToggle?: (e: any) => void
    onBeforeToggle?: (e: any) => void
    onCanPlay?: (e: any) => void
    onCanPlayThrough?: (e: any) => void
    onDurationChange?: (e: any) => void
    onEmptied?: (e: any) => void
    onEnded?: (e: any) => void
    onLoadedData?: (e: any) => void
    onLoadedMetadata?: (e: any) => void
    onLoadStart?: (e: any) => void
    onPause?: (e: any) => void
    onPlay?: (e: any) => void
    onPlaying?: (e: any) => void
    onProgress?: (e: any) => void
    onRateChange?: (e: any) => void
    onSeeked?: (e: any) => void
    onSeeking?: (e: any) => void
    onStalled?: (e: any) => void
    onSuspend?: (e: any) => void
    onTimeUpdate?: (e: any) => void
    onVolumeChange?: (e: any) => void
    onWaiting?: (e: any) => void

    Settings
    Member Visibility

    On This Page
    Properties
    childrenlabelhintstatusstatusIcontonesizevaluedefaultValuelocalehour12minmaxnamedisabledreadOnlyrequirediconclearabledimActionstrailingroundautoFocusonValueChangeonClearClickonClearInputonFocusonBlurclassNamestyleidtitleslottabIndexkeyonClickonDoubleClickonAuxClickonContextMenuonMouseDownonMouseUponMouseEnteronMouseLeaveonMouseMoveonMouseOveronMouseOutonPointerDownonPointerUponPointerMoveonPointerEnteronPointerLeaveonPointerOveronPointerOutonPointerCancelonGotPointerCaptureonLostPointerCaptureonTouchStartonTouchEndonTouchMoveonTouchCancelonKeyDownonKeyUponChangeonInputonBeforeInputonInvalidonResetonSubmitonSelectonCopyonCutonPasteonCompositionStartonCompositionUpdateonCompositionEndonDragonDragStartonDragEndonDragEnteronDragLeaveonDragOveronDroponScrollonWheelonAnimationStartonAnimationEndonAnimationIterationonTransitionEndonLoadonErroronAbortonToggleonBeforeToggleonCanPlayonCanPlayThroughonDurationChangeonEmptiedonEndedonLoadedDataonLoadedMetadataonLoadStartonPauseonPlayonPlayingonProgressonRateChangeonSeekedonSeekingonStalledonSuspendonTimeUpdateonVolumeChangeonWaiting