Element React 中文文档 Element-React Checkbox 多选框

2024-02-25 开发教程 Element React 中文文档 匿名 6

一组备选项中进行多选

基础用法

单独使用可以表示两种状态之间的切换。

简单的 Checkbox,使用checked切换选中状态。

render() {
return <Checkbox checked>备选项</Checkbox>
}

禁用状态

多选框不可用状态。

设置disabled属性即可。

render() {
return (
<div>
<Checkbox disabled>备选项1</Checkbox>
<Checkbox checked disabled>备选项2</Checkbox>
</div>
)
}

多选框组

适用于多个勾选框绑定到同一个数组的情景,通过是否勾选来表示这一组选项中的项。

Checkbox.Group 元素能把多个 checkbox 管理为一组,只需要在 Group 中使用value绑定 Array 类型的变量即可,label属性除了改变 checkbox 按钮后的介绍外,同时也是该 checkbox 对应的值,label与数组中的元素值相对应,如果存在指定的值则为选中状态,否则为不选中。

constructor(props) {
super(props);
this.state = {
checkList: ['复选框 A', '选中且禁用']
}
}
render() {
return (
<Checkbox.Group value={this.state.checkList}>
<Checkbox label="复选框 A"></Checkbox>
<Checkbox label="复选框 B"></Checkbox>
<Checkbox label="复选框 C"></Checkbox>
<Checkbox label="禁用" disabled></Checkbox>
<Checkbox label="选中且禁用" disabled></Checkbox>
</Checkbox.Group>
)
}

indeterminate状态

indeterminate属性用以表示 checkbox 的不确定状态,一般用于实现全选的效果

设置indeterminate属性该表 checkbox 不确定状态.

constructor(props) {
super(props);
this.state = {
checkAll: false,
cities: ['上海', '北京', '广州', '深圳'],
checkedCities: ['上海', '北京'],
isIndeterminate: true,
}
}
handleCheckAllChange(checked) {
const checkedCities = checked ? ['上海', '北京', '广州', '深圳'] : [];
this.setState({
isIndeterminate: false,
checkAll: checked,
checkedCities: checkedCities,
});
}
handleCheckedCitiesChange(value) {
const checkedCount = value.length;
const citiesLength = this.state.cities.length;
this.setState({
checkedCities: value,
checkAll: checkedCount === citiesLength,
isIndeterminate: checkedCount > 0 && checkedCount < citiesLength,
});
}
render() {
return (
<div>
<Checkbox
checked={this.state.checkAll}
indeterminate={this.state.isIndeterminate}
onChange={this.handleCheckAllChange.bind(this)}>全选</Checkbox>
<div style={{margin: '15px 0'}}></div>
<Checkbox.Group
value={this.state.checkedCities}
onChange={this.handleCheckedCitiesChange.bind(this)}>
{
this.state.cities.map((city, index) =>
<Checkbox key={index} label={city}></Checkbox>
)
}
</Checkbox.Group>
</div>
)
}

可选项目数量的限制

使用 minmax属性能够限制可以被勾选的项目的数量。

constructor(props) {
super(props);
this.state = {
checkAll: false,
cities: ['上海', '北京', '广州', '深圳'],
checkedCities: ['上海', '北京'],
isIndeterminate: true,
}
}
handleCheckAllChange(checked) {
const checkedCities = checked ? ['上海', '北京', '广州', '深圳'] : [];
this.setState({
isIndeterminate: false,
checkAll: checked,
checkedCities: checkedCities,
});
}
handleCheckedCitiesChange(value) {
const checkedCount = value.length;
const citiesLength = this.state.cities.length;
this.setState({
checkedCities: value,
checkAll: checkedCount === citiesLength,
isIndeterminate: checkedCount > 0 && checkedCount < citiesLength,
});
}
render() {
return (
<div>
<Checkbox
checked={this.state.checkAll}
indeterminate={this.state.isIndeterminate}
onChange={this.handleCheckAllChange.bind(this)}>全选</Checkbox>
<div style={{margin: '15px 0'}}></div>
<Checkbox.Group
min="1"
max="2"
value={this.state.checkedCities}
onChange={this.handleCheckedCitiesChange.bind(this)}>
{
this.state.cities.map((city, index) =>
<Checkbox key={index} label={city}></Checkbox>
)
}
</Checkbox.Group>
</div>
)
}

按钮样式

按钮样式的多选组合。

只需要把Checkbox元素替换为Checkbox.Button元素即可。此外,Element 还提供了size属性,支持largesmall两种。

constructor(props) {
super(props);
this.state = {
cities: ['上海', '北京', '广州', '深圳'],
checkboxGroup1: ['上海'],
checkboxGroup2: ['北京'],
checkboxGroup3: ['广州']
}
}
render() {
return (
<div>
<div style={{margin: '15px 0'}}></div>
<Checkbox.Group value={this.state.checkboxGroup1}>
{
this.state.cities.map((city, index) => {
return <Checkbox.Button key={index} label={city}>{city}</Checkbox.Button>
})
}
</Checkbox.Group>
<div style={{margin: '15px 0'}}></div>
<Checkbox.Group value={this.state.checkboxGroup2} size="small">
{
this.state.cities.map((city, index) => {
return <Checkbox.Button key={index} label={city} disabled={city === '深圳'}>{city}</Checkbox.Button>
})
}
</Checkbox.Group>
<div style={{margin: '15px 0'}}></div>
<Checkbox.Group value={this.state.checkboxGroup3} size="large" fill="#324057" textColor="#a4aebd" min="1" max="3">
{
this.state.cities.map((city, index) => {
return <Checkbox.Button key={index} label={city}>{city}</Checkbox.Button>
})
}
</Checkbox.Group>
</div>
)
}

Checkbox Attributes

参数说明类型可选值默认值
label选中状态的值(只有在Checkbox.Group或者绑定对象类型为array时有效)string
trueLabel选中时的值string, number
falseLabel没有选中时的值string, number
disabled按钮禁用booleanfalse
checked当前是否勾选booleanfalse
indeterminate设置 indeterminate 状态,只负责样式控制booleanfalse

Checkbox.Group Attributes

参数说明类型可选值默认值
value指定选中的选项string[]-[]
sizeCheckbox 按钮组尺寸stringlarge, small
fill按钮激活时的填充色和边框色string#20a0ff
textColor按钮激活时的文本颜色string#ffffff
min可被勾选的 checkbox 的最大数量number
max可被勾选的 checkbox 的最小数量number

Checkbox.Group Events

事件名称说明回调参数
onChange当绑定值变化时触发的事件value