Skip to content

CdsCheckboxButton

New in v4.0

Контрол чекбокса без лейбла и блока сообщений — атом, на котором собран CdsCheckbox. Используйте его там, где подпись не нужна или живёт снаружи: в ячейке таблицы, строке списка, карточке.

Storybook GitLab Figma
Покрытие тестами: 100% — хорошее покрытие
API в спеках
33 / 33 пропсы, события, слоты и exposed, у которых есть тест
Тест-кейсы
17 юнит · 0 браузерных · 2 в планах
Известные баги
5 зафиксированы тестом it.fails
Покрытие кода
100% строк · 100% ветвей замер v4.0.0-alpha.13
A11y (axe)
1 рекомендаций в 1 историях замер v4.0.0-alpha.11

Для самостоятельной опции с лейблом, описанием и валидацией используйте CdsCheckbox — состояния, цвета и группы работают здесь так же и подробно описаны на его странице.

Базовый пример ​

Контрол управляется через v-model, indeterminate показывает промежуточное состояние, disabled блокирует выбор. Видимого лейбла нет, поэтому добавьте aria-label — так контрол останется понятным для скринридеров.

Sandbox Storybook

API ​

Пропсы

ИмяТипПо умолчаниюОписание
activeColorstring | undefined—Цвет компонента, когда он находится в активном состоянии
baseColorstring | undefined—Цвет неактивного компонента
bgColorstring | undefined—Цвет фона компонента
colorstring | undefined—Цвет компонента
defaultsTargetstring | undefined—Имя дочернего компонента, которому пробрасываются значения пропсов группы по умолчанию
descriptionstring | undefined—Описание компонента, отображаемое под меткой
direction"horizontal" | "vertical" | undefined'horizontal'Переключение между горизонтальным или вертикальным отображением.
disabledboolean | null | undefinednullЗаблокированное состояние
errorboolean | undefined—Переводит компонент в визуальное состояние ошибки
falseIconIconValue | undefined'checkbox-off'Иконка невыбранного состояния
falseValueany—Значение для false состояния.
idstring | undefined—Уникальный идентификатор компонента
indeterminateboolean | undefined—Неопределенное состояние чекбокса.
indeterminateIconIconValue | undefined'checkbox-indeterminate-fill'Иконка для отображения в неопределенном состоянии.
inlineboolean | undefined—Отображает контрол как inline-элемент — контейнер не растягивается на всю ширину
labelstring | undefined—Текст метки (label) компонента
modelValueany—Значение компонента (v-model). В группе — значение выбранного контрола, при multiple — массив выбранных значений
multipleboolean | null | undefinednullРазрешает выбор нескольких значений — модель становится массивом. Включается автоматически, если в modelValue передан массив
namestring | undefined—Атрибут name нативного элемента input. В группе одно имя объединяет все вложенные контролы
readonlyboolean | null | undefinednullТолько для чтения
textColorstring | undefined—Цвет текста компонента
themestring | undefined—Тема компонента
trueIconIconValue | undefined'checkbox-on-fill'Иконка выбранного состояния
trueValueany—Значение для true состояния.
typestring | undefined—Тип нативного элемента input — например, radio или checkbox
valueany—Значение, используемое при выборе компонента в группе. Если оно не указано, будет использоваться уникальный идентификатор.
valueComparatorValueComparator | undefinedtrueФункция сравнения значения модели со значением value контрола. По умолчанию — глубокое сравнение

События

ИмяТипОписание
update:indeterminate[value: boolean]Сработало при смене промежуточного состояния чекбокса
update:modelValue[value: boolean]Сработало при переключении чекбокса. Передаёт новое состояние

Слоты

ИмяТипОписание
default{ backgroundColorClasses: Ref<string[], string[]>; backgroundColorStyles: Ref<CSSProperties, CSSProperties>; }Слот по-умолчанию
description{ description: string | undefined; props: Record<string, any>; }Слот по умолчанию для компонента CdsDescription
inputSelectionControlSlotСлот для элемента ввода по умолчанию.
label{ label: string | undefined; props: Record<string, any>; }Слот по умолчанию для компонента CdsLabel