Interface HeadlessCheckboxValue

A value returned from the useCheckbox hook.

interface HeadlessCheckboxValue {
    inputProps: InputHTMLAttributes<HTMLInputElement>;
    isFocused: boolean;
    isFocusVisible: boolean;
    isHovered: boolean;
    labelProps: LabelHTMLAttributes<HTMLLabelElement>;
}

Properties

inputProps: InputHTMLAttributes<HTMLInputElement>

Props of an element that must have a checkbox behavior.

An object which identity never changes between renders.

isFocused: boolean

true if an element is currently focused.

isFocusVisible: boolean

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

isHovered: boolean

true if an element is currently hovered.

labelProps: LabelHTMLAttributes<HTMLLabelElement>

Props of an element that must have a checkbox label behavior.

An object which identity never changes between renders.