semi-design/content/input/checkbox/index-en-US.md

---

localeCode: en-US order: 23 category: Input title: Checkbox subTitle: Checkbox icon: doc-checkbox

brief: Checkboxes allow the user to select one or more items from a set.

When to use

• When making multiple choices in a set of options;
• Use independently to select from different states, similar to the Switch component. The difference is that switching the Switch triggers a state change directly, while Checkbox is generally used for tagging status and works with the submission.

Demos

How to import

import { Checkbox, CheckboxGroup } from '@douyinfe/semi-ui';

Basic Usage

When the Checkbox is used individually, you can control whether to check it through the defaultChecked and checked attributes. When checked is passed in, it is controlled component.

import React from 'react';
import { Checkbox } from '@douyinfe/semi-ui';

() => (
    <Checkbox aria-label="Checkbox demo" onChange={e => console.log(e)}>
        Semi Design
    </Checkbox>
);

import React from 'react';
import { Checkbox } from '@douyinfe/semi-ui';

() => (
    <Checkbox
        defaultChecked
        onChange={e => console.log(e)}
        aria-label="Checkbox demo"
    >
        Semi Design
    </Checkbox>
);

You can use extra to add extra information. The extra information usually is longer and even has line changes.

import React from 'react';
import { Checkbox } from '@douyinfe/semi-ui';

() => (
    <>
        <Checkbox
            extra='Semi Design is a design system developed and maintained by IES Front-end Team and UED Team'
            aria-label="Checkbox demo"
        >
            Semi Design
        </Checkbox>
        <br/>
        <Checkbox
            extra='Semi Design is a design system developed and maintained by IES Front-end Team and UED Team'
            aria-label="Checkbox demo"
            style={{ width: 400 }}
        >
            Semi Design
        </Checkbox>
    </>
);

Disabled

import React from 'react';
import { Checkbox } from '@douyinfe/semi-ui';

() => (
    <div>
        <Checkbox defaultChecked={false} disabled aria-label="Checkbox demo">UnChecked Disabled</Checkbox>
        <br />
        <Checkbox defaultChecked disabled aria-label="Checkbox demo">Checked Disabled</Checkbox>
    </div>
);

Checkbox Group in JSX

By placing the Checkbox element inside the CheckboxGroup, you can declare the Checkbox group Using the Checkbox group, you can more conveniently control the selection of a group of Checkboxes through the defaultValue and value properties of the CheckboxGroup At this time, Checkbox does not need to declare defaultChecked and checked attributes

import React from 'react';
import { Checkbox, CheckboxGroup } from '@douyinfe/semi-ui';

() => (
    <CheckboxGroup style={{ width: '100%' }} defaultValue={['A', 'B']} aria-label="CheckboxGroup demo">
        <Checkbox value="A">A</Checkbox>
        <Checkbox value="B">B</Checkbox>
        <Checkbox value="C">C</Checkbox>
        <Checkbox value="D">D</Checkbox>
        <Checkbox value="E">E</Checkbox>
    </CheckboxGroup>
);

Checkbox Group in options

You can pass an array using options to CheckboxGroup directly to generate a set of checkboxs.

import React from 'react';
import { CheckboxGroup } from '@douyinfe/semi-ui';

class App extends React.Component {

    render() {
        function onChange(checkedValues) {
            console.log('checked = ', checkedValues);
        }

        const plainOptions = ['semi', 'vigo', 'helo'];
        const options = [
            { label: 'Aim for the highest', value: '1', extra: "Raise the bar. Wait for bigger gains. Find the best solutions by widening your perspective. Be attentive. Distill ideas down to their fundamental truths. Keep learning and growing" },
            { label: 'Be grounded & courageous', value: '2', extra: "Make your own discoveries. Dive deep into facts. Stay level-headed. Focus on impact. Assume ownership, take risks, break the mold. Rapid iterations, multiple possibilities." },
            { label: 'Be open & humble', value: '3', extra: "Trust yourself, trust each other. Be willing to offer and ask for help. Collaboration creates value. Approach problems with the big picture in mind. Be mindful and check your ego; stay open to different ideas." },
            { label: 'Be candid & clear', value: '4', extra: "Dare to share your honest opinions. It's okay to make mistakes. Own it when you do. Stick to the facts, identify issues, and avoid \'leader-pleasing.\' Be accurate and forthright; be methodical and focused." }
        ];
        const optionsWithDisabled = [
            { label: 'Photography', value: 'Photography' },
            { label: 'Movies', value: 'Movies' },
            { label: 'Running', value: 'Running', disabled: false },
        ];
        return (
            <div>
                <CheckboxGroup options={plainOptions} defaultValue={['semi']} onChange={onChange} aria-label="CheckboxGroup demo" />
                <br/><br/>
                <CheckboxGroup options={options} defaultValue={[]} onChange={onChange} aria-label="CheckboxGroup demo" />
                <br/><br/>
                <CheckboxGroup
                    options={optionsWithDisabled}
                    disabled
                    defaultValue={['Photography']}
                    onChange={onChange}
                    aria-label="Checkbox demo"
                />
            </div>
        );
    }
}

Layout Direction

By setting direction to horizontal or vertical, You can adjust the layout within the Checkbox Group.

import React from 'react';
import { CheckboxGroup } from '@douyinfe/semi-ui';

() => {
    const options = [
        { label: 'semi', value: 'semi' },
        { label: 'hotsoon', value: 'hotsoon' },
        { label: 'pipixia', value: 'pipixia' },
        { label: 'toutiao', value: 'toutiao' }
    ];
    return (
        <CheckboxGroup options={options} direction='horizontal' aria-label="CheckboxGroup demo" />
    );
};

Controlled Component

Used as a controlled component.

import React from 'react';
import { Checkbox, Button } from '@douyinfe/semi-ui';

class App extends React.Component {

    constructor() {
        super();
        this.state = {
            checked: true,
            disabled: false,
        };
        this.toggleChecked = this.toggleChecked.bind(this);
        this.toggleDisable = this.toggleDisable.bind(this);
        this.onChange = this.onChange.bind(this);
    }

    toggleChecked () {
        this.setState({ checked: !this.state.checked });
    };

    toggleDisable () {
        this.setState({ disabled: !this.state.disabled });
    };

    onChange (e) {
        console.log('checked = ', e.target.checked);
        this.setState({
            checked: e.target.checked,
        });
    };

    render() {
        const label = `${this.state.checked ? 'Checked' : 'Unchecked'} ${
            this.state.disabled ? 'Disabled' : 'Enabled'
        }`;
        return (
            <div>
                <p style={{ marginBottom: '20px' }}>
                    <Checkbox
                        checked={this.state.checked}
                        disabled={this.state.disabled}
                        onChange={this.onChange}
                        aria-label="Checkbox demo"
                    >
                        {label}
                    </Checkbox>
                </p>
                <p>
                    <Button type="primary" size="small" onClick={this.toggleChecked}>
                        {!this.state.checked ? 'Check' : 'Uncheck'}
                    </Button>
                    <Button
                        style={{ marginLeft: '10px' }}
                        type="primary"
                        size="small"
                        onClick={this.toggleDisable}
                    >
                        {!this.state.disabled ? 'Disable' : 'Enable'}
                    </Button>
                </p>
            </div>
        );
    }
}

Checkbox State

You may use the indeterminate property to set the state to indeterminate.

import React, { useState } from 'react';
import { Checkbox, CheckboxGroup } from '@douyinfe/semi-ui';

() => {
    const plainOptions = ['Photography', 'Movies', 'Running'];
    const [checkedList, setCheckedList] = useState(['Photography', 'Running']);
    const [indeterminate, setIndeterminate] = useState(true);
    const [checkAll, setCheckall] = useState(false);
    const onChange = (checkedList) => {
        setCheckedList(checkedList);
        setIndeterminate(!!checkedList.length && checkedList.length < plainOptions.length);
        setCheckall(checkedList.length === plainOptions.length);
    };
    const onCheckAllChange = (e) => {
        console.log(e);
        setCheckedList(e.target.checked ? plainOptions : []);
        setIndeterminate(false);
        setCheckall(e.target.checked);
    };

    return (
        <div>
            <div style={{ paddingBottom: 8, borderBottom: '1px solid var(--semi-color-border)' }}>
                <Checkbox
                    indeterminate={indeterminate}
                    onChange={onCheckAllChange}
                    checked={checkAll}
                    aria-label="Checkbox demo"
                >
                    Check all
                </Checkbox>
            </div>
            <CheckboxGroup
                style={{ marginTop: 6 }}
                options={plainOptions}
                value={checkedList}
                onChange={onChange}
                aria-label="CheckboxGroup demo"
            />
        </div>
    );
};

Card Style

version: >=1.30.0

You can set type='card' to CheckboxGroup to realize card style with background.

import React from 'react';
import { CheckboxGroup, Checkbox } from '@douyinfe/semi-ui';

() => (
    <CheckboxGroup type='card' defaultValue={['1', '3']} direction='vertical' aria-label="Checkbox demo">
        <Checkbox value={'1'} disabled extra='Checkbox Description' style={{ width: 280 }}>
            Checkbox Title
        </Checkbox>
        <Checkbox value={'2'} disabled extra='Checkbox Description' style={{ width: 280 }}>
            Checkbox Title
        </Checkbox>
        <Checkbox value={'3'} extra='Checkbox Description' style={{ width: 280 }}>
            Checkbox Title
        </Checkbox>
        <Checkbox value={'4'} extra='Checkbox Description' style={{ width: 280 }}>
            Checkbox Title
        </Checkbox>
    </CheckboxGroup>
);

Pure Card Style

version: >=1.30.0

You can set type='pureCard' to CheckboxGroup to realize a pure card style with background and no checkbox.

import React from 'react';
import { CheckboxGroup, Checkbox } from '@douyinfe/semi-ui';

() => (
    <CheckboxGroup type='pureCard' defaultValue={['1', '3']} direction='vertical' aria-label="Checkbox demo">
        <Checkbox value={'1'} disabled extra='Checkbox Description' style={{ width: 280 }}>
            Checkbox Title
        </Checkbox>
        <Checkbox value={'2'} disabled extra='Checkbox Description' style={{ width: 280 }}>
            Checkbox Title
        </Checkbox>
        <Checkbox value={'3'} extra='Checkbox Description' style={{ width: 280 }}>
            Checkbox Title
        </Checkbox>
        <Checkbox value={'4'} extra='Checkbox Description' style={{ width: 280 }}>
            Checkbox Title
        </Checkbox>
    </CheckboxGroup>
);

Using with Grid

Use Checkbox.Group with Grid to achieve flexible layouts.

import React from 'react';
import { CheckboxGroup, Checkbox, Row, Col } from '@douyinfe/semi-ui';

() => (
    <CheckboxGroup style={{ width: '100%' }} aria-label="Checkbox demo">
        <Row>
            <Col span={8}>
                <Checkbox value="A">A</Checkbox>
            </Col>
            <Col span={8}>
                <Checkbox value="B">B</Checkbox>
            </Col>
            <Col span={8}>
                <Checkbox value="C">C</Checkbox>
            </Col>
            <Col span={8}>
                <Checkbox value="D">D</Checkbox>
            </Col>
            <Col span={8}>
                <Checkbox value="E">E</Checkbox>
            </Col>
        </Row>
    </CheckboxGroup>
);

API Reference

Checkbox

PROPERTIES	Instructions	type	Default
addonId	id of addon node, aria-labelledby refers to this id, if not set, it will generate an id randomly provided after v2.11.0	string
aria-label	Define label of the Checkbox	string	-
checked	Specify whether the current Checkbox is selected (it is invalid when used in Group)	boolean	false
type	Set the type of checkboxe, one of: default、card、pureCard provided after v2.18.0	string	default
defaultChecked	Whether Checked by default (it is invalid when used in Group)	boolean	false
disabled	Disabled state	boolean	false
extra	Provide extra information >= v0.25.0	ReactNode	-
extraId	id of extra node. aria-describedby refers to this id, if not set, it will randomly generate an id provided after v2.11.0	ReactNode	-
value	The value that the checkbox represents in the CheckboxGroup	any	-
indeterminate	Set to indeterminate state, style control only	boolean	false
preventScroll	Indicates whether the browser should scroll the document to display the newly focused element, acting on the focus method inside the component, excluding the component passed in by the user	boolean
onChange	Callback function when change	function(e: Event)	-

CheckboxGroup

PROPERTIES	Instructions	type	Default
defaultValue	Options selected by default	string\string[]	[]
direction	Layout of checkbox within a group, one of vertical, horizontal	string	vertical
disabled	Disable the entire group	boolean	false
name	The name attribute for all input[type="checkbox"] in Checkbox Group	string	-
options	Specify optional	any[]	[]
type	Set the type of checkboxes, one of: default、card、pureCard provided after v1.30.0	string	default
value	Specify selected options	any[]	[]
onChange	Callback function when selected options change	function(checkedValue)	-

Methods

Some internal methods provided by Checkbox can be accessed through ref:

Checkbox

Name	Description
blur()	Remove focus
focus()	Get focus

Accessibility

ARIA

• The role of Checkbox is checkbox, the role of CheckboxGroup is list, and its direct child element is listitem
• aria-label: When using the Checkbox alone, if Children have no text, it is recommended to pass in the aria-label prop to describe the function of the Checkbox in one sentence, which will make the screen reader read out the content of this label. If you are using Form.Checkbox, you can use the label provided by Form without passing in aria-label
• aria-labelledby points to the addon node, used to explain the role of the current Checkbox
• aria-describedby points to the extra node, which is used to supplement the explanation of the current Checkbox
• aria-disabled indicates the current disabled state, which is consistent with the value of the disabled prop
• aria-checked indicates the current checked state

Keyboard and focus

• Checkbox can be focused, keyboard users can use Tab and Shift + Tab to switch focus.
• The Checkbox that gets the focus can switch the selected and unselected states through Space.
• The click area of ​​Checkbox is larger than the box itself and contains the text behind the box; for checkboxes with auxiliary text, the auxiliary text is also included in the click area.
• Disabled Checkbox is not focusable.

Content Guidelines

Checkbox Content Demo

• Capitalize the first letter
• No punctuation

Design Tokens

Related Material