CheckboxGroup

Группа флажков с массивом выбранных значений.

Дочерние элементы — Checkbox или Toggle; onChange возвращает массив value. label, description и errorMessage добавляют заголовок группы, пояснение и текст ошибки. Собственные disabled, size и name пунктов сохраняются.

Живой пример

Group label

Настройки примера

Использование

import { Checkbox, CheckboxGroup } from '@prosazhin/pbcomponents';

<CheckboxGroup
  label='Options'
  defaultValue={['One']}
>
  {['One', 'Two', 'Three', 'Four', 'Five'].map((item) => (
    <Checkbox
      key={item}
      value={item}
    >
      {item}
    </Checkbox>
  ))}
</CheckboxGroup>;

API компонента

PropТип / вариантыНазначениеПо умолчанию
childrenCheckbox[] | Toggle[]Пункты группы; можно сочетать Checkbox и Toggle. Собственные disabled, size и name пунктов сохраняются.—
size's' | 'm's · mРазмер компонента.—
labelReactNodeЗаголовок группы (legend).—
descriptionReactNodeПояснение под заголовком группы.—
errorMessageReactNodeТекст ошибки под группой; связывается с группой через aria-describedby.—
namestringОбщее имя нативных полей группы.—
disabledbooleanБлокирует взаимодействие.false
valuestring[]Выбранные значения.—
defaultValuestring[]Начальное значение без внешнего управления.[]
onChange(values: string[]) => voidСообщает массив выбранных значений.—
classNamestringКласс корневого элемента.—

Нативные HTML-атрибуты поддерживаются там, где компонент рендерит соответствующий элемент. Параметры className управляют только оформлением.