For AI agents: the complete documentation index is available at https://rickyshin93.github.io/tao-ui/llms.txt, the full documentation bundle is available at https://rickyshin93.github.io/tao-ui/llms-full.txt, and this page is available as Markdown at https://rickyshin93.github.io/tao-ui/components/checkbox.md.
v0.0.57
  • English
  • Checkbox

    Data Entry@rockshin/tao-ui

    Selects one or more independent boolean options.

    When to use

    Use Checkbox for independent choices, or CheckboxGroup when users can select multiple options from a set.

    Recommended

    • Use clear labels that describe the checked state.
    • Group related options with CheckboxGroup.

    Avoid

    • Do not use CheckboxGroup when only one option may be selected; use RadioGroup instead.

    Examples

    Basic usage

    TSX

    Standalone states

    TSX

    Vertical groups

    TSX

    Controlled checkbox

    onChange provides a native event; read the next value from target.checked.

    Not subscribed
    TSX

    Select all and indeterminate

    Derive indeterminate state from the selected count instead of storing separate conflicting state.

    Read
    TSX

    Vertical options and disabled items

    Object options allow individual disabled items; direction controls layout.

    TSX

    Native form values

    Write controlled selections into hidden inputs and read them with FormData.

    TSX

    Sizes and shared disabled state

    A local Provider can set size or disable a group of controls.

    TSX

    API

    CheckboxGroup

    PropertyDescriptionTypeDefault Value
    disabledWhether to disableboolean | undefined-

    Checkbox

    PropertyDescriptionTypeDefault Value
    disabledWhether to disableboolean | undefined-
    requiredRequire a checked value when submitting a native form.boolean | undefined-