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 for the element that implements checkbox 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<HTMLLabelElement>

Props for the element that implements checkbox label behavior.

The object identity never changes between renders.