BalanceReckon Design System

Checkbox

Checkboxes provide users with a range of options for a given statement where the user may select any number of choices, including zero, one or multiple.

CheckboxPrimitiveProps

PropTypeRequiredDefaultDescription
checkedboolean | 'mixed'——A `boolean` value indicates whether or not this checkbox is checked. A `"mixed"` value indicates `indeterminate`, meaning that its state cannot be determined or stated in pure binary terms. This may happen, for instance, if the state of the checkbox depends on multiple other checkboxes, and those checkboxes have different values.
disabledboolean——When true, the checkbox will be disabled.
sizeCheckboxSize
small|medium
——The size of the checkbox.
valuestring——The value of the checkbox.
Also accepts InputProps

CheckboxProps

PropTypeRequiredDefaultDescription
childrenReactNode——The checkbox label content.
Also accepts CheckboxPrimitiveProps

CheckboxGroupProps

PropTypeRequiredDefaultDescription
childrenReactNodeYes——
disabledboolean———
legendstringYes——
namestring———
onChange(selectedValues: string[]) => voidYes——
sizeCheckboxSize
small|medium
———
valuestring[]Yes——