ngx-editor — это визуальный WYSIWYG-редактор для приложений на Angular, построенный поверх фреймворка ProseMirror. Проект предназначен для интеграции в одностраничные приложения и предоставляет набор компонентов и сервисов, упрощающих создание, редактирование и управление структурированным контентом с сохранением совместимости со схемами ProseMirror. В структуре редактора предусмотрены механизмы для работы с документной моделью, управления состоянием редактора и обработки пользовательских команд.
Разработка ngx-editor ориентирована на расширяемость и настраиваемость: он предлагает модульную архитектуру, позволяющую подключать плагины, определять собственные ноды и марки, а также формировать пользовательскую панель инструментов. Благодаря использованию ProseMirror в основе обеспечиваются детерминированные операции над документом, откат/повтор действий и управление курсором на уровне модели. В случаях, когда официальной или исчерпывающей документации по конкретной реализации недостаточно, описание ограничивается общими характеристиками и типичными сценариями использования WYSIWYG-редакторов на базе ProseMirror в экосистеме Angular.
- Интеграция с Angular: модульная установка в Angular-приложение, компоненты для шаблонов и привязки через реактивные формы.
- Основан на ProseMirror: использование документной модели ProseMirror, поддержка транзакций, шагов и истории изменений.
- Настраиваемая панель инструментов: возможность добавлять, удалять и конфигурировать кнопки и элементы управления форматированием и вставкой контента.
- Расширяемость: API для подключения плагинов, определения собственных нод и марок, обработчиков ввода и команд.
- Импорт/экспорт форматов: поддержка сериализации документа в HTML и/или JSON-представление ProseMirror для сохранения и восстановления.
- Управление состоянием: сервисы для доступа к состоянию редактора, подписок на изменения и программной модификации контента.
- Поддержка клавиатурных команд: стандартные сочетания для форматирования, а также возможность добавления пользовательских хоткеев.
- Валидация и ограничение структуры: возможность задания правил валидации документа и ограничений для вложенных нод.
- Механизмы Undo/Redo: встроенная история транзакций и управление шагами отката и повтора.
- Межплатформенная совместимость: работа в современных браузерах и совместимость с серверной генерацией разметки при необходимости.