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

API

Опции плагина

ПолеОписаниеОбязательное поле
containerID элемента, в который встраивается редактор. По умолчанию plugin-container.
localeЯзык, доступные варианты: en и ru. По умолчанию ru.
uidУникальный ID письма в вашей системе.
autosaveВключить/выключить автосохранение: true/false. Либо объект { interval: number }. По умолчанию true.
tokenТокен авторизации.
pluginIdID инсталляции плагина, настроенный в консоли разработчика.
onОбъект со списком обработчиков событий редактора.

Обработчики событий

СобытиеОписаниеПараметры
readyВызывается один раз, когда редактор готов к работе.{ json: TemplateJSON, html: string, lastSavedTemplate: { json: TemplateJSON, savedDt: Date } }
historyВызывается при обновлении истории изменений.{ hasUndos: boolean, hasRedos: boolean }
toggleMenuВызывается при переключении меню редактора.{ menu: null | 'audit' | 'guide' | 'style' | 'blocks' }
togglePreviewВызывается при переключении видимости превью письма.{ state: boolean, json: TemplateJSON, html: string, darkHTML: string }
toggleGridВызывается при переключении видимости сетки письма.{ state: boolean }
autosaveВызывается при автосохранении.{ json: TemplateJSON, html: string }
uploadImageВызывается при загрузке изображения (например, при дропе файла).{ file: string, name: string }
openGalleryВызывается при нажатии на открытие галереи.{}
notificationУведомления о событиях редактора.{ intent: 'error' | 'info' | 'success' | 'warning', errorDetails?: object, message?: string, title: string }
exitВыход из редактора.{ json: TemplateJSON, html: string }
saveСохранение письма.{ json: TemplateJSON, html: string }
errorОшибка в редакторе.{ code: string, message: string, details: {} }

Методы редактора

МетодОписаниеПараметры
startИнициирует старт редактора на странице.{ template: TemplateJSON, templateName: string }
exportContentАсинхронное действие, возвращает JSON и HTML.-
cleanОчистка последней сохранённой локальной версии (используется при обрыве сессии).-
exitИнициирует выход из редактора.-
saveИнициирует сохранение письма.-
redoВперёд по истории изменений.-
undoНазад по истории изменений.-
toggleMenuПереключает меню.{ menu: null | 'audit' | 'guide' | 'style' | 'blocks' }
togglePreviewПереключает видимость превью.{ state?: boolean }
toggleGridПереключает видимость сетки.{ state?: boolean }
applyImageПрименяет изображение после события открытия галереи.{ url?: string }
changeTemplateМеняет контент шаблона.{ template: TemplateJSON }