Interface FormattedInputValue<V>

A value returned from the useFormattedInput hook.

interface FormattedInputValue<V> {
    formattedValue: string;
    inputProps: InputHTMLAttributes<HTMLInputElement>;
    isFocused: boolean;
    isFocusVisible: boolean;
    isHovered: boolean;
    labelProps: LabelHTMLAttributes<HTMLElement>;
    value: V;
}

Properties

formattedValue: string

The formatted value rendered in the input.

inputProps: InputHTMLAttributes<HTMLInputElement>

Props for the element that implements the formatted 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 the input label behavior.

The object identity never changes between renders.

value: V

The current edited value.