Перейти к основному содержимому

toggle-list

Описание

Срабатывает, когда пользователь переключает список на выбранных блоках

Событие toggle-list обеспечивает работу контекстно-зависимых кнопок маркированного/нумерованного списка. Вместо того чтобы вставлять новый список, событие анализирует текущее выделение и автоматически выбирает одно из четырёх поведений:

РежимКогда срабатываетРезультат
WrapВыделение охватывает только параграфыКаждый параграф становится элементом списка внутри одного нового контейнера списка
UnwrapКаждый охваченный элемент находится в списке выбранного типаЭлементы возвращаются в параграфы; контейнер списка удаляется
ConvertКаждый охваченный элемент находится в списке, но хотя бы один из них относится к другому типуСписок меняет свой тип (маркированный ↔ нумерованный) на месте
MixedВыделение смешивает параграфы и элементы спискаПараграфы становятся элементами, и всё объединяется в один список выбранного типа

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

"toggle-list": ({ type: TListType }) => boolean | void;

type TListType = "bulleted" | "numbered";

Параметры

Колбэк события toggle-list может принимать объект со следующим параметром:

  • type - тип списка для переключения. Допустимые значения:
    • "bulleted" - маркированный (неупорядоченный) список
    • "numbered" - нумерованный (упорядоченный) список
Информация

Для обработки внутренних событий используйте методы Event Bus

Пример

// инициализация RichText
const editor = new richtext.Richtext("#root", {
// свойства конфигурации
});
// подписка на событие "toggle-list"
editor.api.on("toggle-list", (obj) => {
console.log(obj.type);
console.log("The list was toggled");
});

Журнал изменений: Событие добавлено в v2.0.6