Системные настройки
Все настройки находятся в разделе «Системные настройки», пространство имён tiptapeditor. Их можно переопределить в настройках контекста, группы пользователей или пользователя. При обновлении пакета значения не сбрасываются.
TIP
Страница собирается автоматически из исходников пакета (npm run docs:generate).
Интерфейс
| Ключ | Описание | По умолчанию |
|---|---|---|
tiptapeditor.toolbar | Панель инструментов Кнопки через пробел, группы через «|». Пример: undo redo | heading | bold italic | link image. | undo redo | heading | bold italic underline strike code | color highlight | superscript subscript | align | bulletList orderedList | blockquote horizontalRule | link modxLink anchor | image gallery file table embed | codeBlock | clearFormatting | source fullscreen |
tiptapeditor.profiles | Профили JSON-объект именованных профилей, например {"simple": {"toolbar": "bold italic link"}}. Профиль переопределяет toolbar и функции. | (пусто) |
tiptapeditor.default_profile | Профиль по умолчанию Профиль, который используется, если не задан другой. | default |
tiptapeditor.content_profile | Профиль поля content Профиль для поля content ресурса. Пусто — профиль по умолчанию. | (пусто) |
tiptapeditor.tv_profiles | Профили TV Имя TV → профиль: JSON-объект, например {"introtext": "simple"}, или пары имя=профиль по одной в строке или через запятую. | (пусто) |
tiptapeditor.heading_levels | Уровни заголовков Доступные уровни заголовков через запятую. | 1,2,3,4,5,6 |
tiptapeditor.bubble_menu | Всплывающее меню Показывать меню форматирования над выделенным текстом. | Да |
tiptapeditor.floating_menu | Плавающее меню Показывать меню вставки на пустом абзаце. | Да |
tiptapeditor.slash_commands | Slash-команды Ввод «/» на пустой строке открывает меню блоков. | Да |
tiptapeditor.statusbar | Строка состояния Показывать количество слов и символов и путь текущего элемента. | Нет |
tiptapeditor.sticky_toolbar | Закреплённая панель Панель инструментов остаётся видимой при прокрутке. | Да |
tiptapeditor.enable_fullscreen | Полноэкранный режим Разрешить кнопку полноэкранного режима (выход — Esc). | Да |
tiptapeditor.min_height | Минимальная высота Минимальная высота редактора в пикселях. | 200 |
tiptapeditor.max_height | Максимальная высота Максимальная высота при автоувеличении, в пикселях. 0 — без ограничения. | 700 |
tiptapeditor.default_height | Высота по умолчанию Высота редактора в пикселях, если автоувеличение выключено. | 300 |
tiptapeditor.autogrow | Автоувеличение Редактор растёт вместе с содержимым до максимальной высоты. | Да |
tiptapeditor.content_css | CSS содержимого Список CSS-файлов сайта через запятую для отображения содержимого в редакторе, например /assets/css/content.css,/assets/css/article.css. | (пусто) |
Содержимое
| Ключ | Описание | По умолчанию |
|---|---|---|
tiptapeditor.enable_tables | Таблицы Таблицы в редакторе: кнопка таблицы и панель таблицы. Если выключено, контент с таблицами остаётся в обычном текстовом поле. | Да |
tiptapeditor.enable_images | Изображения Включить изображения. | Да |
tiptapeditor.enable_iframe | Iframe и встраивание Включить iframe и встраивание видео. | Да |
tiptapeditor.iframe_allowed_attributes | Разрешённые атрибуты iframe Список разрешённых атрибутов iframe через запятую. Обработчики событий (on*) удаляются всегда. | src,width,height,allow,allowfullscreen,loading,title,name,referrerpolicy,frameborder,class,id,style |
tiptapeditor.iframe_allowed_hosts | Разрешённые хосты iframe Список хостов, разрешённых в src у iframe, через запятую. Пусто — любой хост. | (пусто) |
tiptapeditor.paste_as_text | Вставка как текст Вставлять содержимое буфера обмена как простой текст. | Нет |
tiptapeditor.image_classes | Пресеты классов изображений Классы для изображений: JSON-объект {"css-класс": "Название"} или список классов через запятую. | (пусто) |
tiptapeditor.enable_gallery | Галереи Включить кнопку «Галерея»: несколько изображений по шаблону (сетка, слайдер…). | Да |
tiptapeditor.gallery_template | Шаблон галереи Шаблон новых галерей: grid (сетка), slider (разметка Swiper), images (только изображения) или имя из tiptapeditor.gallery_templates. | grid |
tiptapeditor.gallery_templates | Свои шаблоны галерей JSON с дополнительными шаблонами, например {"cards": {"label": "Карточки", "wrapper": "<ul class="cards">{items}</ul>", "item": "<li>{image}{caption}</li>"}}. {items} — изображения, {image} — изображение (со ссылкой, если включено увеличение), {caption} — <figcaption> с подписью. Скрипты и атрибуты on* удаляются. | (пусто) |
tiptapeditor.lightbox | Увеличение изображений по клику Новые изображения и галереи получают ссылку на изображение вокруг картинки (<figure><a href="…"><img></a></figure>) для скрипта-лайтбокса на сайте. В диалоге включается и выключается для каждой картинки и галереи. | Нет |
tiptapeditor.lightbox_attribute | Атрибут лайтбокса Атрибут, который ищет ваш скрипт-лайтбокс, например data-fancybox (Fancybox), data-lightbox, data-gallery. У одиночного изображения он без значения, у галереи — с именем группы (data-fancybox="gallery-3fa9c1"). Пусто — обычная ссылка. | (пусто) |
tiptapeditor.lightbox_label | Подпись ссылки увеличения aria-label ссылки, {alt} — альтернативный текст или подпись. Пусто — «Открыть изображение: {alt}» на языке менеджера. | (пусто) |
tiptapeditor.link_classes | Пресеты классов ссылок CSS-классы для диалога ссылки: JSON-объект {"css-класс": "Название"} или список классов через запятую. Пусто — свободное текстовое поле. | (пусто) |
tiptapeditor.paragraph_classes | Пресеты классов абзацев Классы для абзацев: JSON-объект {"css-класс": "Название"} или список классов через запятую. | (пусто) |
tiptapeditor.table_classes | Пресеты классов таблиц CSS-классы в диалоге таблицы: JSON-объект {"css-класс": "Название"} (в одной записи можно несколько классов) или список через запятую. | (пусто) |
tiptapeditor.preserve_style_attribute | Сохранять атрибут style Сохранять существующие атрибуты style без изменений. Выключите, чтобы удалять inline-стили. | Да |
Интеграция с MODX
| Ключ | Описание | По умолчанию |
|---|---|---|
tiptapeditor.protect_modx_syntax | Защита тегов MODX Сохранять теги MODX, например [[*pagetitle]] и [[!snippet? ...]], без изменений: они показываются защищёнными плашками, не экранируются и не разбиваются, в том числе при правке текста вокруг. | Да |
tiptapeditor.protect_fenom_syntax | Защита Fenom Сохранять конструкции Fenom, например {$var}, {if}...{/if} и {foreach}, без изменений: они показываются защищёнными плашками или карточками и не экранируются. «{ » с пробелом остаётся текстом (CSS, JSON). | Да |
tiptapeditor.fenom_tags | Дополнительные теги Fenom Имена собственных тегов или функций Fenom через запятую (myTag, other), которые нужно защищать помимо встроенных ключевых слов (if, foreach, set, include, ...). | (пусто) |
tiptapeditor.modx_autocomplete | Автодополнение MODX Подсказывать поля, сниппеты, чанки и настройки при вводе тегов MODX. | Да |
tiptapeditor.fenom_autocomplete | Автодополнение Fenom Подсказывать основные переменные Fenom при вводе. | Нет |
tiptapeditor.links_across_contexts | Ссылки между контекстами Нет (по умолчанию): поиск ресурса MODX в диалоге ссылки ищет только в контексте редактируемого ресурса. Да: во всех контекстах, доступных пользователю (кроме mgr). | Нет |
tiptapeditor.resource_link_format | Формат ссылки на ресурс href для ресурса MODX, выбранного в диалоге ссылки. {id} — ID ресурса (обязательно); также заменяются {context} и {uri}. По умолчанию: [[~{id}]]. | [[~{id}]] |
tiptapeditor.media_source | Источник файлов ID источника файлов для файлового браузера. Пусто — источник контекста по умолчанию или источник TV. | (пусто) |
tiptapeditor.media_url_mode | Формат URL файлов «relative» (по умолчанию) — URL в точности как вернул файловый менеджер MODX, как в TV «Изображение»; «root» — к относительным URL добавляется base URL сайта (например, /assets/img/a.jpg). Абсолютные URL (S3 и другие удалённые источники) всегда сохраняются как есть. | relative |
tiptapeditor.upload_enabled | Загрузка перетаскиванием и вставкой Загружать перетащенные и вставленные в редактор изображения в источник файлов поля, в папку tiptapeditor.upload_path. Загрузка идёт через штатную загрузку MODX (право file_upload, политики источника, разрешённые типы файлов и upload_maxsize). Изображения никогда не сохраняются в base64. | Нет |
tiptapeditor.upload_path | Папка загрузки Папка в источнике файлов поля для перетащенных и вставленных изображений, например assets/uploads/. | assets/uploads/ |
Система
| Ключ | Описание | По умолчанию |
|---|---|---|
tiptapeditor.external_config | Внешняя конфигурация Путь к JSON-файлу с дополнительной конфигурацией, например {core_path}config/tiptapeditor.json. Читаются только данные, код не выполняется. | (пусто) |
tiptapeditor.debug | Режим отладки Выводить диагностические сообщения в консоль браузера и журнал ошибок MODX. | Нет |