Interface HeadlessTextInputValue

A value returned from the useTextInput hook.

interface HeadlessTextInputValue {
    inputProps: InputHTMLAttributes<HTMLElement>;
    isFocused: boolean;
    isFocusVisible: boolean;
    isHovered: boolean;
    labelProps: LabelHTMLAttributes<HTMLElement>;
    value: string;
}

Properties

inputProps: InputHTMLAttributes<HTMLElement>

Props for the element that implements text input behavior.

The object identity never changes between renders.

isFocused: boolean

true if the element is currently focused.

isFocusVisible: boolean

true if the element is currently focused and focus should be visible.

isHovered: boolean

true if the element is currently hovered.

labelProps: LabelHTMLAttributes<HTMLElement>

Props for the element that implements input label behavior.

The object identity never changes between renders.

value: string

The current input text value.