React Hookers - v6.3.0
    Preparing search index...

    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 Summary)

    Index

    Properties

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

    Properties

    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.

    id?: string

    An ID that uniquely identifies a text input.

    isAutofocused?: boolean

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

    false
    isDisabled?: boolean

    If true then hover events are disabled.

    false
    isInvalid?: boolean

    If true then an input is marked as invalid.

    false
    isTextArea?: boolean

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

    false
    onBlur?: () => void

    A handler that is called when the element loses focus.

    onChange: (value: string) => void

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

    Type declaration

      • (value: string): void

      • Parameters

        • value: string

          An input text value.

        Returns void

    onFocus?: () => void

    A handler that is called when the element receives focus.

    onFocusChange?: (isFocused: boolean) => void

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

    Type declaration

      • (isFocused: boolean): void

      • Parameters

        • isFocused: boolean

          true if an element is focused.

        Returns void

    onFocusVisible?: () => void

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

    onHoverChange?: (isHovered: boolean) => void

    A handler that is called when the hover state changes.

    Type declaration

      • (isHovered: boolean): void

      • Parameters

        • isHovered: boolean

          true if an element is hovered.

        Returns void

    onHoverEnd?: () => void

    A handler that is called when a hover interaction ends.

    onHoverStart?: () => void

    A handler that is called when a hover interaction starts.

    value: undefined | string

    An input text value.

    Settings

    Member Visibility

    On This Page

    Properties