wm/pipIrr.git - Gitblit

---
title: Checkbox 多选框
description: 用于预设的一组选项中执行多项选择，并呈现选择结果。
spline: form

isComponent: true

引入

全局引入，在 miniprogram 根目录下的app.json中配置，局部引入，在需要引入的页面或组件的index.json中配置。

"usingComponents": {
  "t-checkbox": "tdesign-miniprogram/checkbox/checkbox",
  "t-checkbox-group": "tdesign-miniprogram/checkbox-group/checkbox-group"
}

代码演示

组件类型

纵向多选框

横向多选框

带全选多选框

组件状态

多选框状态

组件样式

勾选样式

勾选显示位置

非通栏多选样式

组件规格

多选框尺寸规格

API

Checkbox Props

名称	类型	默认值	说明	必传
block	Boolean	true	是否为块级元素	N
borderless	Boolean	false	是否开启无边框模式	N
check-all	Boolean	false	用于标识是否为「全选选项」。单独使用无效，需在 CheckboxGroup 中使用	N
checked	Boolean	false	是否选中	N
default-checked	Boolean	undefined	是否选中。非受控属性	N

Checkbox Events

名称	参数	描述
change	`(checked: boolean, context: { value: boolean\|number\|string, label: boolean\|number\|string })`	值变化时触发。`context` 表示当前点击项内容。

Checkbox 外部样式类

类名	说明
t-class	根节点样式类
t-class-label	标签样式类
t-class-icon	图标样式类
t-class-content	内容样式类
t-class-border	边框样式类

CheckboxGroup Props

名称	类型	默认值	说明	必传
borderless	Boolean	false	是否开启无边框模式	N

disabled | Boolean | - | 是否禁用组件，默认为 false。 CheckboxGroup.disabled < Checkbox.disabled ，后续新增 Form 组件后，Form.disabled 优先级最低 | N
max | Number | undefined | 支持最多选中的数量 | N
name | String | - | 统一设置内部复选框 HTML 属性 | N
options | Array | [] | 以配置形式设置子元素。示例1：['北京', '上海'] ，示例2: [{ label: '全选', checkAll: true }, { label: '上海', value: 'shanghai' }]。checkAll 值为 true 表示当前选项为「全选选项」。TS 类型：Array<CheckboxOption> type CheckboxOption = string \| number \| CheckboxOptionObj interface CheckboxOptionObj { label?: string; value?: string \| number; disabled?: boolean; checkAll?: true }。详细类型定义 | N
value | Array | [] | 选中值。TS 类型：T type CheckboxGroupValue = Array<string \| number \| boolean>。详细类型定义 | N
default-value | Array | undefined | 选中值。非受控属性。TS 类型：T type CheckboxGroupValue = Array<string \| number \| boolean>。详细类型定义 | N

CheckboxGroup Events

名称	参数	描述
change	`(value: CheckboxGroupValue, context: { value: boolean\|number\|string, label: boolean\|number\|string })`	值变化时触发。`context` 表示当前点击项内容。

CSS 变量