Для независимых опций, которые включаются по отдельности, — CdsCheckbox, для настройки «вкл/выкл», применяемой сразу, — CdsToggle. Если вариантов больше пяти, сверните список в CdsSelect.
Анатомия
Заголовок и описание подписывают весь набор, ниже — радиокнопки: у каждой контрол с иконкой состояния, лейбл и необязательное описание. Внизу — общий блок сообщений группы. Клик по лейблу выбирает кнопку так же, как клик по контролу.
Вариации
Заголовок и описание
Свойство label называет группу, description поясняет выбор. У каждой кнопки свои label и description: коротко назовите вариант в лейбле, а детали — цену, сроки, ограничения — уберите в описание.
Направление
По умолчанию кнопки выстраиваются в столбец. direction="horizontal" ставит их в ряд — удобно для коротких наборов из двух-трёх вариантов вроде периода или сортировки.
Состояния
disabled блокирует всю группу и снижает контрастность, readonly запрещает менять выбор, но не меняет внешний вид. Отдельный вариант блокируется свойством disabled самой кнопки.
Сообщения и ошибки
messages показывает вспомогательный текст под группой, error-messages — готовое сообщение об ошибке (например, пришедшее с сервера) вместе с состоянием ошибки у всех кнопок. Правила валидации через rules — в сценарии «Отправка формы». hide-details убирает нижний блок целиком.
Цвета
color задаёт цвет выбранной кнопки, base-color — невыбранных. Значения применяются сразу ко всем кнопкам группы.
Слоты
Когда текстовых пропсов недостаточно, содержимое блоков заменяется слотами — у группы и у каждой кнопки.
| Имя слота | Описание |
|---|---|
label | Содержимое заголовка группы (замещает label) |
description | Содержимое описания группы (замещает description) |
prepend | Элемент до набора кнопок |
append | Элемент после набора кнопок |
messages | Содержимое блока сообщений |
details | Нижний блок целиком |
У CdsRadio есть свои слоты label и description — например, чтобы подсветить часть текста или добавить иконку.
Рекомендации
Сценарии использования
Отправка формы
Выбор обязателен: правило в rules возвращает текст ошибки, пока значение не выбрано. Кнопка запускает проверку через validate() формы CdsForm.
Выбор тарифа
Описания кнопок подсказывают условия, а вычисляемый итог под группой обновляется при каждом выборе — пользователь видит последствия сразу.
Сортировка списка
Горизонтальная группа с hide-details работает как панель сортировки: выбранное значение пересобирает список на лету через computed.
API
Пропсы, события и слоты отдельной кнопки — на странице CdsRadio.
Пропсы
| Имя | Тип | По умолчанию | Описание |
|---|---|---|---|
activeColor | string | undefined | — | Цвет компонента, когда он находится в активном состоянии |
appendIcon | IconValue | undefined | — | Иконка в слоте append после контента |
baseColor | string | undefined | — | Цвет неактивного компонента |
bgColor | string | undefined | — | Цвет фона компонента |
centerAffix | boolean | undefined | true | Выровнять по вертикали элементы appendInner, prependInner, clearIcon и label по центру. |
color | string | undefined | — | Цвет компонента |
defaultsTarget | string | undefined | — | Имя дочернего компонента, которому пробрасываются значения пропсов группы по умолчанию |
description | string | undefined | — | Описание компонента, отображаемое под меткой |
direction | "horizontal" | "vertical" | undefined | 'vertical' | Переключение между горизонтальным или вертикальным отображением. |
disabled | boolean | null | undefined | null | Заблокированное состояние |
error | boolean | undefined | — | Переводит компонент в визуальное состояние ошибки |
errorMessages | string | readonly string[] | null | undefined | [] | Отображает компонент в состояние ошибки и передает пользовательские сообщения об ошибках.
Будет объединяться с любыми проверками, заданными в свойстве rules.
Это поле не запускает валидацию. |
falseIcon | IconValue | undefined | 'radio-off' | Иконка невыбранной радиокнопки |
focused | boolean | undefined | — | Управляет состоянием фокуса компонента. Когда true, компонент считается сфокусированным и может применять соответствующие стили или поведение. |
height | string | number | undefined | 'auto' | Высота компонента |
hideDetails | boolean | "auto" | undefined | — | Скрытие блока с деталями (сообщениями и подсказками). При значении 'auto' блок скрывается, если нет сообщений |
hideMessages | boolean | undefined | — | Скрыть сообщения под полем ввода |
hint | string | undefined | — | Текст подсказки, отображаемый под полем ввода |
iconColor | string | boolean | undefined | — | Цвет иконки. Принимает булево значение или строку с цветом |
id | string | undefined | — | Уникальный идентификатор компонента |
inline | boolean | undefined | — | Отображает контрол как inline-элемент — контейнер не растягивается на всю ширину |
label | string | undefined | — | Текст метки (label) компонента |
maxErrors | string | number | undefined | 1 | Максимальное число отображаемых ошибок при валидации |
maxWidth | string | number | undefined | — | Максимальная ширина компонента |
messages | string | readonly string[] | undefined | [] | Сообщения для отображения под полем ввода |
minWidth | string | number | undefined | — | Минимальная ширина компонента |
modelValue | any | — | Значение компонента (v-model). В группе — значение выбранного контрола, при multiple — массив выбранных значений |
name | string | undefined | — | Атрибут name нативного элемента input. В группе одно имя объединяет все вложенные контролы |
persistentHint | boolean | undefined | — | Всегда отображать подсказку, а не только при фокусе |
prependIcon | IconValue | undefined | — | Иконка в слоте prepend перед контентом |
readonly | boolean | null | undefined | null | Только для чтения |
rules | readonly ValidationRule[] | undefined | [] | Принимает массив, состоящий из элементов различных типов: функций, логических значений и строк. Функции принимают входное значение в качестве аргумента и должны возвращать либо true / false, либо строку, содержащую сообщение об ошибке. Поле ввода перейдет в состояние ошибки, если функция возвращает значение false (или любое значение в массиве содержит false) либо является строкой. |
size | number | "xs" | "sm" | "md" | "lg" | "xl" | undefined | 'md' | Размер компонента |
textColor | string | undefined | — | Цвет текста компонента |
theme | string | undefined | — | Тема компонента |
trueIcon | IconValue | undefined | 'radio-on' | Иконка выбранной радиокнопки |
type | string | undefined | 'radio' | Тип нативного элемента input у кнопок группы |
validateOn | ValidateOn | undefined | — | Изменяет тип события, при котором запускается валидация |
validationValue | any | — | Значение, используемое при применении правил валидации |
valueComparator | ValueComparator | undefined | true | Функция сравнения значения модели со значением value контрола. По умолчанию — глубокое сравнение |
width | string | number | undefined | — | Ширина компонента |
События
| Имя | Тип | Описание |
|---|---|---|
update:modelValue | [value: any] | Событие, которое срабатывает при изменении модели компонента |
Слоты
| Имя | Тип | Описание |
|---|---|---|
append | CdsInputSlot | Добавляет элемент после поля ввода |
default | any | Слот по умолчанию — радиокнопки группы (CdsRadio) |
description | { description: string | undefined; props: Record<string, any>; } | Слот по умолчанию для компонента CdsDescription |
details | CdsInputSlot | Слот для ввода пользовательских данных, позволяющее настраивать отображение сообщений |
label | { label: string | undefined; props: Record<string, any>; } | Слот по умолчанию для компонента CdsLabel |
message | CdsMessageSlot | Слот для настройки содержания сообщения |
messages | CdsInputSlot | Слот для ввода пользовательских данных, позволяющее настраивать отображение сообщений |
prepend | CdsInputSlot | Добавляет элемент до поля ввода |
Exposed
| Имя | Тип | Описание |
|---|---|---|
isDirty | boolean | Является ли поле ввода "грязным" |
isDisabled | boolean | Является ли поле ввода заблокированным |
isPure | boolean | Является ли поле ввода "чистым" |
isReadonly | boolean | Является ли поле ввода только для чтения |
isValid | boolean | null | Является ли поле ввода валидным |
isValidating | boolean | Является ли поле ввода в процессе валидации |
reset | () => Promise<void> | Функция сброса поля ввода в исходное состояние |
resetValidation | () => Promise<void> | Функция сброса валидации поля ввода |
validate | (silent?: boolean) => Promise<string[]> | Функция валидации поля ввода |