Interface HeadlessCheckboxProps

Props of 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 full)

Properties

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

Properties

Optionalid

id?: string

An ID that uniquely identifies a checkbox.

OptionalisAutofocused

isAutofocused?: boolean

If true then element is auto-focusable inside a focus scope.

Default

false

OptionalisChecked

isChecked?: boolean

If true then a checkbox is checked.

Default

false

OptionalisDisabled

isDisabled?: boolean

If true then hover events are disabled.

Default

false

OptionalisInvalid

isInvalid?: boolean

If true then a checkbox is marked as invalid.

Default

false

OptionalonBlur

onBlur?: (() => void)

A handler that is called when the element loses focus.

OptionalonChange

onChange?: ((isChecked: boolean) => void)

A handler that is called when a checkbox is checked or unchecked.

Type declaration

    • (isChecked): void

    • Parameters

      • isChecked: boolean

        true if checkbox is checked.

      Returns void

OptionalonFocus

onFocus?: (() => void)

A handler that is called when the element receives focus.

OptionalonFocusChange

onFocusChange?: ((isFocused: boolean) => void)

A handler that is called when the element's focus status changes.

Type declaration

    • (isFocused): void

    • Parameters

      • isFocused: boolean

        true if an element is focused.

      Returns void

OptionalonFocusVisible

onFocusVisible?: (() => void)

A handler that is called when the element receives focus that must be visible to a user.

OptionalonHoverChange

onHoverChange?: ((isHovered: boolean) => void)

A handler that is called when the hover state changes.

Type declaration

    • (isHovered): void

    • Parameters

      • isHovered: boolean

        true if an element is hovered.

      Returns void

OptionalonHoverEnd

onHoverEnd?: (() => void)

A handler that is called when a hover interaction ends.

OptionalonHoverStart

onHoverStart?: (() => void)

A handler that is called when a hover interaction starts.

Settings

Member Visibility

On This Page

Properties