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