Skip to content

Checkbox

Components7.9.2

Checkbox

Wrapper over the checkbox with the label tag.

import Checkbox from '@semcore/ui/checkbox';
<Checkbox />;
typeCheckboxProps
BoxProps & {...}
PropertyDescription
state
CheckboxState = normal

Checkbox state

size

Checkbox size

theme
string

A checkbox theme you can add your own color to

Checkbox.Value

Represents input[type=checkbox] and span with an icon. Properties apply to the icon, except for those specified in includeInputProps.

import Checkbox from '@semcore/ui/checkbox';
<Checkbox.Value />;
typeCheckboxValueProps
KeyboardFocusProps & FlexProps & {...}
PropertyDescription
onChange
(checked: boolean, e: React.SyntheticEvent) => void

Handler to change

checked
boolean

Control status

defaultChecked
boolean = false

The initial status for uncontrolled mode

indeterminate
boolean

The value responsible for the indeterminate attribute

includeInputProps
string[]

List of props that will be added to the hidden input

state
CheckboxState = normal

The value responsible for the state of the component

size

Checkbox size

theme
string

A checkbox theme you can add your own color to

Checkbox.Text

It is the customized Text from @semcore/ui/typography, depending on the size.

import Checkbox from '@semcore/ui/checkbox';
<Checkbox.Text />;
typeCheckboxTextProps
TextProps & {...}
PropertyDescription
disabled
boolean