Обзор АПИ

Конструктор RichText

new richtext.RichText("#root", {
    // параметры конфигурации
});

Параметры:

• HTML-контейнер (например, CSS-селектор или DOM-элемент)
• объект конфигурации (см. свойства)

Методы RichText

Название	Описание
getValue()	Возвращает значение RichText
setValue()	Применяет новое значение к RichText
insertValue()	Вставляет текст, Markdown или HTML-контент в текущую позицию курсора или заменяет выделенный текст
setConfig()	Применяет новые параметры конфигурации к RichText
setLocale()	Применяет новую локаль к RichText
destructor()	Удаляет все HTML-элементы RichText и отключает все связанные события

Методы Event Bus

Название	Описание
api.exec()	Позволяет инициировать внутренние события
api.intercept()	Позволяет перехватывать и отменять внутренние события
api.on()	Позволяет прикрепить обработчик к внутренним событиям
api.detach()	Позволяет удалять/отсоединять обработчики событий
api.setNext()	Позволяет добавить действие в порядок обработки Event Bus

Методы состояния

Название	Описание
api.getState()	Возвращает объект со свойствами StateStore компонента RichText
api.getReactiveState()	Возвращает объект с реактивными свойствами RichText

События

Название	Описание
align	Срабатывает при изменении выравнивания текста через меню/панель инструментов или методы Event Bus
clear-text-format	Срабатывает при очистке форматирования текста через меню/панель инструментов или методы Event Bus
copy	Срабатывает при копировании выделенного текста
create-new	Срабатывает при нажатии пункта "New" в строке меню или через методы Event Bus
cut	Срабатывает при вырезании выделенного текста
delete-link	Вызывается при удалении ссылки
export	Срабатывает после нажатия пункта «Export» в меню или через методы Event Bus
import	Срабатывает после нажатия опции «Import» в строке меню или через методы Event Bus
indent	Срабатывает при увеличении отступа блока
insert-image	Срабатывает при вставке изображения (через панель инструментов, строку меню, вставку из буфера обмена или перетаскивание)
insert-line	Срабатывает при вставке горизонтальной линии
insert-link	Срабатывает при вставке ссылки
insert-list	Срабатывает при вставке списка
outdent	Срабатывает при уменьшении отступа блока
paste	Срабатывает при вставке содержимого
print	Срабатывает при печати документа
redo	Срабатывает при нажатии кнопки "Redo" в строке меню/панели инструментов или через методы Event Bus
resize-image	Срабатывает при изменении размера изображения
set-font-family	Срабатывает при установке семейства шрифтов
set-font-size	Срабатывает при установке размера шрифта
set-line-height	Срабатывает при установке межстрочного интервала
set-text-color	Срабатывает при установке цвета текста и/или цвета фона текста
set-text-format	Срабатывает при установке формата текста
set-text-style	Срабатывает при установке стиля текста
show-popup	Срабатывает при показе или скрытии всплывающего окна
subscript	Вызывается при нажатии кнопки «Subscript» в строке меню/панели инструментов или через методы Event Bus
superscript	Срабатывает при нажатии кнопки «Надстрочный» в строке меню/панели инструментов или через методы Event Bus
toggle-fullscreen-mode	Срабатывает при переключении полноэкранного режима
toggle-layout-mode	Срабатывает при переключении режима разметки
toggle-shortcut-info	Срабатывает при переключении информации о горячих клавишах
undo	Срабатывает при нажатии кнопки «Отменить» в строке меню/панели инструментов или через методы Event Bus
update-link	Срабатывает при обновлении ссылки

Свойства

Название	Описание
defaultStyles	Необязательный. Задаёт значения стилей по умолчанию для конкретных типов блоков
fullscreenMode	Необязательный. Включает полноэкранный режим RichText
imageUploadUrl	Необязательное. Задаёт URL, который будет использоваться для загрузки изображений (из панели инструментов, строки меню, вставки из буфера обмена или перетаскивания)
layoutMode	Необязательный. Задаёт режим отображения основной области редактора
locale	Необязательный. Объект, содержащий метки локализации RichText
menubar	Необязательный. Включает верхний меню-бар RichText
toolbar	Необязательный. Включает панель инструментов и позволяет задавать/настраивать кнопки, отображаемые в ней
value	Необязательный. Задаёт начальное значение (содержимое), отображаемое в области редактора RichText