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

    数据录入@rockshin/tao-ui

    选择一个或多个相互独立的布尔选项。

    何时使用

    独立选择使用 Checkbox;从一组选项中多选时使用 CheckboxGroup。

    推荐

    • 标签应准确描述选中后的状态。
    • 相关选项使用 CheckboxGroup 组织。

    避免

    • 只能选一个选项时不要使用 CheckboxGroup,应改用 RadioGroup。

    代码演示

    基础用法

    TSX

    独立状态

    TSX

    纵向选项组

    TSX

    受控复选框

    onChange 提供原生事件,从 target.checked 读取新值。

    Not subscribed
    TSX

    全选与半选

    由当前选项数量计算半选状态,避免分别维护互相矛盾的状态。

    Read
    TSX

    垂直排列与禁用选项

    对象形式的 options 可单独禁用选项,direction 控制排列方向。

    TSX

    原生表单值

    将受控选项写入隐藏输入,再通过 FormData 读取。

    TSX

    尺寸与共享禁用

    局部 Provider 统一尺寸,也可统一禁用一组控件。

    TSX

    API

    CheckboxGroup

    属性说明类型默认值
    disabled是否禁用boolean | undefined-

    Checkbox

    属性说明类型默认值
    disabled是否禁用boolean | undefined-
    requiredRequire a checked value when submitting a native form.boolean | undefined-