@hmiproject/helio-sdk
    Preparing search index...

    Type Alias CheckboxProps

    type CheckboxProps = {
        ariaLabel?: string;
        autoFocus?: boolean;
        checked: CheckboxCheckedType;
        disabled?: boolean;
        label: ReactNode;
        onCheckedChange(checked: boolean): void;
    }
    Index

    Properties

    ariaLabel?: string

    Provide an accessible name for screen readers. Use this when label contains no readable text — e.g. when it renders only an icon, or when it is empty. It replaces the visible label for assistive technology.

    `Enable notifications`
    
    autoFocus?: boolean

    Automatically focus the checkbox when it is rendered to the UI

    The checked state of the checkbox. Supports an 'indeterminate' state in addition to true and false.

    disabled?: boolean
    false
    
    label: ReactNode

    Label displayed next to the checkbox. Required so the choice is explicit: the prop can't be omitted. The type still permits "empty" values, though — "", null, undefined, and false all render no label.

    Methods

    • Called when the user toggles the checkbox.

      Parameters

      • checked: boolean

      Returns void