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

    Interface HeadlessCheckboxProps

    Props for the useCheckbox hook.

    interface HeadlessCheckboxProps {
        id?: string;
        isAutofocused?: boolean;
        isChecked?: boolean;
        isDisabled?: boolean;
        isInvalid?: boolean;
        onBlur?: () => void;
        onChange?: (isChecked: boolean) => void;
        onFocus?: () => void;
        onFocusChange?: (isFocused: boolean) => void;
        onFocusVisible?: () => void;
        onHoverChange?: (isHovered: boolean) => void;
        onHoverEnd?: () => void;
        onHoverStart?: () => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id? isAutofocused? isChecked? isDisabled? isInvalid? onBlur? onChange? onFocus? onFocusChange? onFocusVisible? onHoverChange? onHoverEnd? onHoverStart?

    Properties

    id?: string

    An ID that uniquely identifies the checkbox.

    isAutofocused?: boolean

    If true, the element is auto-focusable within a focus scope.

    false
    isChecked?: boolean

    If true, the checkbox is checked.

    false
    isDisabled?: boolean

    If true, hover interactions are disabled.

    false
    isInvalid?: boolean

    If true, the checkbox is marked as invalid.

    false
    onBlur?: () => void

    A handler that is called when the element loses focus.

    onChange?: (isChecked: boolean) => void

    A callback invoked when the checkbox is checked or unchecked.

    Type Declaration

      • (isChecked: boolean): void

      • Parameters

        • isChecked: boolean

          true if the checkbox is checked.

        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 state changes.

    Type Declaration

      • (isFocused: boolean): void

      • Parameters

        • isFocused: boolean

          true if the element is focused.

        Returns void

    onFocusVisible?: () => void

    A handler that is called when the element receives focus and focus should be visible.

    onHoverChange?: (isHovered: boolean) => void

    A handler that is called when the hover state changes.

    Type Declaration

      • (isHovered: boolean): void

      • Parameters

        • isHovered: boolean

          true if the 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.

    Settings

    Member Visibility

    On This Page

    Properties