Что такое Web Editor API?
Web Editor API — это способ добавить редактор документов МойОфис на сайт или в свое веб-приложение. Через API вы не только встраиваете редактор, но и управляете им из своего кода.
Как использовать API
Есть несколько вариантов использования Web Editor API:
- Настройте вид и функции редактора, интегрируйте его в свое приложение.
- Создавайте надстройки, чтобы добавить новые функции или интеграции.
Как встроить редактор
- Подключите библиотеку:
import { EditorBuilder } from '@nct/web-editor-api';
- Добавьте элемент для редактора в HTML:
<div id="editor-container"></div>
- Создайте экземпляр редактора с настройками и запустите:
const container = document.getElementById('editor-container');
const editorBuilder = new EditorBuilder()
.withLocale('ru-RU')
.mount(container, 'http://localhost:9002/');
Редактор готов к работе и управлению через API.
Управление редактором
После встраивания получите объект editorApi для управления интерфейсом:
const editorApi = await editorBuilder.mount(container);
Пример: добавьте свою вкладку на панель инструментов редактора.
editorApi.ui.ribbon.addTab({...});
Остальные возможности смотрите в документации EditorApi.
Как создать надстройку
-
Создайте отдельный js-файл.
-
Опишите и экспортируйте функцию onInit:
export default {
onInit(editorApi) {
// Ваш код
console.log('Надстройка запущена');
}
}
Надстройка автоматически получит доступ ко всем возможностям редактора.
Ссылки на подробные инструкции:
- Как интегрировать редактор: «Интеграция редактора»
- Как мигрировать редактор на API: «Миграция редактора на API»
- Как создать надстройку: «Руководстве по созданию надстроек».