Checkbox

A Checkbox is a form element that enables a binary choice and a Checkbox Group is a collection of Checkboxes.

Installation

yarn add @twilio-paste/checkbox - or - yarn add @twilio-paste/core

Usage

import {Checkbox, CheckboxGroup} from '@twilio-paste/core/checkbox';

const Component = () => (
  <CheckboxGroup name="foo" legend="foo">
    <Checkbox id="foo" value="foo" name="foo">
      Foo
    </Checkbox>
  </CheckboxGroup>
);

Props

Checkbox

checked

Use on the currently selected checkbox

Type: boolean
Default: null

defaultChecked

Only for use with uncontrolled checkboxes

Type: boolean
Default: null

element

Overrides the default element name to apply unique styles with the Customization Provider

Type: any
Default: CHECKBOX

hasError

Type: boolean
Default: null

helpText

Type: | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | ReactFragment | ReactPortal
Default: null

id

Type: string
Default: unique id

indeterminate

Type: boolean
Default: null

isSelectAll

Type: boolean
Default: null

isSelectAllChild

Type: boolean
Default: null

Inherited props

CheckboxGroup

name RequiredRequired

Type: string
Default: null

element

Overrides the default element name to apply unique styles with the Customization Provider

Type: any
Default: CHECKBOX_GROUP

i18nRequiredLabel

Accessible label for the required dot

Type: string
Default: (required)

isSelectAll

Type: boolean
Default: null

onChange

Type: (checked: boolean) => void
Default: null

Inherited props

CheckboxDisclaimer

checked

Use on the currently selected checkbox

Type: boolean
Default: null

defaultChecked

Only for use with uncontrolled checkboxes

Type: boolean
Default: null

element

Overrides the default element name to apply unique styles with the Customization Provider

Type: any
Default: CHECKBOX_DISCLAIMER

errorText

Sets the Checkbox Group in error state

Type: | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | ReactFragment | ReactPortal
Default: null

id

Type: string
Default: unique id