API компонента Switch
Полное описание API компонента Switch, включая пропсы, события, слоты и публичные методы/состояния.
Пропсы
Компонент Switch принимает следующие пропсы:
| Пропс | По умолчанию | Тип | Описание |
|---|---|---|---|
mode | "none" | SwitchMode | Стиль оформления переключателя |
rounded | 9999 | 1-10 или number или "full" | Степень скругления углов |
iconActive | undefined | IconsProps["type"] | Иконка для активного состояния |
iconInactive | undefined | IconsProps["type"] | Иконка для неактивного состояния |
switchingType | "checkbox" | "checkbox" или "switch" или string | Тип переключателя |
id | undefined | string или undefined | Уникальный идентификатор компонента |
modelValue | undefined | boolean или null или undefined | Текущее значение переключателя |
label | "" | string или undefined | Текстовая метка рядом с переключателем |
disabled | false | boolean или undefined | Отключает переключатель при true |
help | undefined | string или undefined | Подсказка под переключателем |
required | false | boolean или undefined | Обязательность выбора |
class | undefined | StyleClass или undefined | Пользовательский CSS-класс контейнера |
События
Компонент Switch генерирует следующие события:
| Событие | Данные | Описание |
|---|---|---|
update:modelValue | boolean | Изменение значения modelValue |
updateModelValue | boolean | Аналог update:modelValue |
change:modelValue | boolean | Изменение состояния переключателя |
Слоты
Компонент Switch предоставляет следующие слоты:
| Слот | Данные | Описание |
|---|---|---|
default | VNode[] | Основной слот для пользовательского контента |
Публичные методы
Компонент Switch предоставляет следующие методы и состояния через ref:
| Метод/Состояние | Значение | Описание |
|---|---|---|
id | SwitchProps["id"] | Уникальный идентификатор |
mode | SwitchProps["mode"] | Текущий стиль оформления |
label | SwitchProps["label"] | Текстовая метка |
rounded | SwitchProps["rounded"] | Степень скругления углов |
isDisabled | SwitchProps["disabled"] | Состояние отключения |
isRequired | SwitchProps["required"] | Обязательность выбора |
iconActive | SwitchProps["iconActive"] | Иконка активного состояния |
iconInactive | SwitchProps["iconInactive"] | Иконка неактивного состояния |
switchingType | SwitchProps["switchingType"] | Тип переключателя |
classBaseSwitch | StyleClass | CSS-класс базового контейнера |
classSwitch | StyleClass | CSS-класс элемента переключателя |
Методы:
inputEvent(value: boolean): void- Обработчик событий ввода для переключения состояния