Перейти к основному содержимому
Версия: 26.1.0 (в разработке)

Interface: MayBeChecked

Expand

Интерфейс для элементов UI, которые могут быть в состояниях "включено"/"выключено".

Используется для переключателей, флажков и других двоичных компонентов.

Remarks

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

  • Переключатель (toggle) между включенным и выключенным состояниями
  • Флажок (checkbox) для отмечания/отмечания
  • Любой компонент с бинарным состоянием

Визуальные изменения:

  • checked = true — компонент выглядит "активным" (галочка, заполненный флажок)
  • checked = false — компонент выглядит "неактивным" (пусто, незаполненный)

Extended by

Properties

checked?

readonly optional checked: boolean

Состояние компонента: включено (true) или выключено (false).

Remarks

true — компонент в состоянии "включено":

  • Галочка в флажке
  • Переключатель в "ВКЛ" позиции
  • Радиокнопка заполнена
  • Визуально выглядит активным

false — компонент в состоянии "выключено":

  • Флажок пуст
  • Переключатель в "ВЫКЛ" позиции
  • Радиокнопка не заполнена
  • Визуально выглядит неактивным

undefined — состояние не определено:

  • Используется редко
  • Может означать неопределённое состояние (не да, не нет)

Example

Флажок (checkbox)

{
id: 'checkbox:confirm',
type: 'checkbox',
title: 'Я согласен с условиями',
checked: false // Изначально не отмечено
}

Переключатель (toggle)

{
id: 'toggle:darkmode',
type: 'toggle',
title: 'Тёмный режим',
checked: true // Изначально включено
}

Обновление состояния

editorApi.ui.updateUiNodes([{
id: 'checkbox:confirm',
updates: {
checked: true // Отметить флажок
}
}]);