Interface HeadlessTextInputProps

Props of the useTextInput hook.

interface HeadlessTextInputProps {
    autoComplete?: HTMLInputAutoCompleteAttribute;
    id?: string;
    isAutofocused?: boolean;
    isDisabled?: boolean;
    isInvalid?: boolean;
    isTextArea?: boolean;
    onBlur?: (() => void);
    onChange: ((value: string) => void);
    onFocus?: (() => void);
    onFocusChange?: ((isFocused: boolean) => void);
    onFocusVisible?: (() => void);
    onHoverChange?: ((isHovered: boolean) => void);
    onHoverEnd?: (() => void);
    onHoverStart?: (() => void);
    value: undefined | string;
}

Hierarchy (view full)

Properties

autoComplete? id? isAutofocused? isDisabled? isInvalid? isTextArea? onBlur? onChange onFocus? onFocusChange? onFocusVisible? onHoverChange? onHoverEnd? onHoverStart? value

Properties

OptionalautoComplete

autoComplete?: HTMLInputAutoCompleteAttribute

What permission the user agent has to provide automated assistance in filling out form field values, as well as guidance to the browser as to the type of information expected in the field.

Optionalid

id?: string

An ID that uniquely identifies a text input.

OptionalisAutofocused

isAutofocused?: boolean

If true then element is auto-focusable inside a focus scope.

Default

false

OptionalisDisabled

isDisabled?: boolean

If true then hover events are disabled.

Default

false

OptionalisInvalid

isInvalid?: boolean

If true then an input is marked as invalid.

Default

false

OptionalisTextArea

isTextArea?: boolean

If true then a text input is treated as a textarea element.

Default

false

OptionalonBlur

onBlur?: (() => void)

A handler that is called when the element loses focus.

onChange

onChange: ((value: string) => void)

A handler that is called when an input text value is changed.

Type declaration

    • (value): void

    • Parameters

      • value: string

        An input text value.

      Returns void

OptionalonFocus

onFocus?: (() => void)

A handler that is called when the element receives focus.

OptionalonFocusChange

onFocusChange?: ((isFocused: boolean) => void)

A handler that is called when the element's focus status changes.

Type declaration

    • (isFocused): void

    • Parameters

      • isFocused: boolean

        true if an element is focused.

      Returns void

OptionalonFocusVisible

onFocusVisible?: (() => void)

A handler that is called when the element receives focus that must be visible to a user.

OptionalonHoverChange

onHoverChange?: ((isHovered: boolean) => void)

A handler that is called when the hover state changes.

Type declaration

    • (isHovered): void

    • Parameters

      • isHovered: boolean

        true if an element is hovered.

      Returns void

OptionalonHoverEnd

onHoverEnd?: (() => void)

A handler that is called when a hover interaction ends.

OptionalonHoverStart

onHoverStart?: (() => void)

A handler that is called when a hover interaction starts.

value

value: undefined | string

An input text value.

Settings

Member Visibility

On This Page

Properties