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

Обзор АПИ

Конструктор 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