Support CoreUI Development
CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing.
You can support our Open Source software development in the following ways:
- Buy the CoreUI PRO, and get access to PRO components, and dedicated support.
- Hire Us! We create stunning designs, high-conversion landing pages, functional mobile apps and reliable web services – everything you need to offer your products or services online and always stay a tap away from your customers.
- Give us a star ⭐️ on Github.
React Checkbox Components
Create consistent cross-browser and cross-device checkboxes with our React checkbox components.
Other frameworks
CoreUI components are available as native Angular, Bootstrap (Vanilla JS), and Vue components. To learn more please visit the following pages.
Approach#
Browser default checkboxes and radios are replaced with the help of <CFormCheck>. Checkboxes are for selecting one or several options in a list.
Checkboxes#
1<CFormCheck id="flexCheckDefault" label="Default checkbox"/>2<CFormCheck id="flexCheckChecked" label="Checked checkbox" defaultChecked />
Indeterminate#
Checkboxes can utilize the :indeterminate pseudo-class when manually set via indeterminate property.
1<CFormCheck id="flexCheckIndeterminate" label="Indeterminate checkbox" indeterminate />
Disabled#
Add the disabled attribute and the associated <label>s are automatically styled to match with a lighter color to help indicate the input's state.
1<CFormCheck label="Disabled checkbox" disabled/>2<CFormCheck label="Disabled checked checkbox" defaultChecked disabled/>
Default (stacked)#
By default, any number of checkboxes that are immediate sibling will be vertically stacked and appropriately spaced.
1<CFormCheck id="defaultCheck1" label="Default checkbox"/>2<CFormCheck id="defaultCheck2" label="Disabled checkbox" disabled/>
Inline#
Group checkboxes on the same horizontal row by adding inline boolean property to any <CFormCheck>.
1<CFormCheck inline id="inlineCheckbox1" value="option1" label="1"/>2<CFormCheck inline id="inlineCheckbox2" value="option2" label="2"/>3<CFormCheck inline id="inlineCheckbox3" value="option3" label="3 (disabled)" disabled/>
Without labels#
Remember to still provide some form of accessible name for assistive technologies (for instance, using aria-label).
1<CFormCheck id="checkboxNoLabel" value="" aria-label="..."/>
Checkbox toggle buttons#
Create button-like checkboxes and radio buttons by using button boolean property on the <CFormCheck> component. These toggle buttons can further be grouped in a button group if needed.
1<CFormCheck button={{ color: 'primary' }} id="btn-check" autoComplete="off" label="Single toggle" />
1<CFormCheck2 button={{ color: 'primary' }}3 id="btn-check-2"4 autoComplete="off"5 label="Checked"6 defaultChecked7/>
1<CFormCheck2 button={{ color: 'primary' }}3 id="btn-check-3"4 autoComplete="off"5 label="Disabled"6 disabled7/>
Outlined styles#
Different variants of button, such at the various outlined styles, are supported.
1<CFormCheck button={{ color: 'primary', variant: 'outline' }} id="btn-check-outlined" autoComplete="off" label="Single toggle"/>2<CFormCheck button={{ color: 'secondary', variant: 'outline' }} id="btn-check-2-outlined" autoComplete="off" label="Checked" defaultChecked/>
API#
CFormCheck#
1import { CFormCheck } from '@coreui/react'2// or3import CFormCheck from '@coreui/react/src/components/form/CFormCheck'
| Property | Description | Type | Default |
|---|---|---|---|
| button | Create button-like checkboxes and radio buttons. | ButtonObject | - |
| className | A string of all className you want applied to the component. | string | - |
| feedback 4.2.0+ | Provide valuable, actionable feedback. | ReactNode | - |
| feedbackInvalid 4.2.0+ | Provide valuable, actionable feedback. | ReactNode | - |
| feedbackValid 4.2.0+ | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, :invalid and :valid. | ReactNode | - |
| floatingLabel 4.2.0+ | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, :invalid and :valid. | ReactNode | - |
| hitArea | Sets hit area to the full area of the component. | 'full' | - |
| id | The id global attribute defines an identifier (ID) that must be unique in the whole document. | string | - |
| indeterminate | Input Checkbox indeterminate Property. | boolean | - |
| inline | Group checkboxes or radios on the same horizontal row by adding. | boolean | - |
| invalid | Set component validation state to invalid. | boolean | - |
| label | The element represents a caption for a component. | ReactNode | - |
| tooltipFeedback 4.2.0+ | Display validation feedback in a styled tooltip. | boolean | - |
| type | Specifies the type of component. | 'checkbox' | 'radio' | checkbox |
| valid | Set component validation state to valid. | boolean | - |