Checkbox多选框

多选框。

何时使用#

  • 在一组可选项中进行多项选择时;
  • 单独使用可以表示两种状态之间的切换,和 switch 类似。区别在于切换 switch 会直接触发状态改变,而 checkbox 一般用于状态标记,需要和提交操作配合。
import { NzCheckboxModule } from 'ng-zorro-antd/checkbox';

代码演示

简单的 checkbox。

expand codeexpand code
      加载中
    


联动 checkbox。

expand codeexpand code
      加载中
    

在实现全选效果时,你可能会用到 nzIndeterminate 属性。

expand codeexpand code
      加载中
    

nz-checkbox-wrapper 内嵌 nz-checkbox 并与 Grid 组件一起使用,可以实现灵活的布局。

⚠️ nz-checkbox-wrapper 已被弃用,推荐使用 nz-checkbox-group

expand codeexpand code
      加载中
    

checkbox 不可用。

expand codeexpand code
      加载中
    




方便的从数组生成 Checkbox 组。

expand codeexpand code
      加载中
    

nz-checkbox-group 内嵌 nz-checkbox 并与 Grid 组件一起使用,可以实现灵活的布局。

expand codeexpand code
      加载中
    

API#

[nz-checkbox]#

参数说明类型默认值
[nzId]组件内部 input 的 idstring-
[nzName]组件内部 input 的 namestring-
[nzAutoFocus]自动获取焦点booleanfalse
[nzDisabled]设定 disable 状态booleanfalse
[ngModel]指定当前是否选中,可双向绑定booleanfalse
[nzIndeterminate]设置 indeterminate 状态,只负责样式控制booleanfalse
[nzValue]仅与 nz-checkbox-wrapper 的选中回调配合使用any-
(ngModelChange)选中变化时回调EventEmitter<boolean>-

nz-checkbox-group#

参数说明类型默认值
[ngModel]指定可选项,可双向绑定{ label: string; value: string; checked?: boolean; }[][]
[nzName]CheckboxGroup 下所有 input 的 name 属性string-
[nzOptions]指定可选项string[] | number[] | NzCheckboxOption[][]
[nzDisabled]设定全部 checkbox disable 状态booleanfalse
(ngModelChange)选中数据变化时的回调EventEmitter<{ label: string; value: string; checked?: boolean; }[]>-

nz-checkbox-wrapper#

参数说明类型默认值
(nzOnChange)选中数据变化时的回调EventEmitter<any[]>-

方法#

[nz-checkbox]#

通过 ViewChild 或其他方式获得 nz-checkbox 实例

名称描述
focus()获取焦点
blur()移除焦点

Interfaces#

NzCheckboxOption#

export interface NzCheckboxOption {
  label: string;
  value: string | number;
  disabled?: boolean;
}