Skip to content

Latest commit

 

History

History
62 lines (54 loc) · 4.41 KB

README.md

File metadata and controls

62 lines (54 loc) · 4.41 KB
Raw

ue-tinymce

Компонент с визуальным редактором (TinyMCE)[https://www.tinymce.com/].

{
  "name": "ue-tinymce",
  "settings": {
    "label": "Компонент tinymce",
    "hint": "Это большое и красивое текстовое поле",
    "required": false,
    "readonly": false,
    "multiple": false,
    "width": 8,
    "defaultValue": "<p>Текст</p>",
    "expandable": true,
    "disabled": false,
    "multiname": "new_value",
    "tinymce-init": {
      "menubar": false,
      "skin": "lightgray",
      "theme": "modern",
      "plugins": [
        "advlist autolink lists link image charmap print hr anchor pagebreak",
        "searchreplace wordcount visualblocks visualchars code",
        "insertdatetime nonbreaking save table contextmenu textcolor"
      ],
      "toolbar1": "insertfile undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent",
      "toolbar2": "forecolor backcolor emoticons | link image",
      "language": "ru"
    }
  }
}

Настройки

Параметр Тип Описание Обязательный параметр? Значение по-умолчанию
label string Название поля (выводится в интерфейсе редактора). + -
hint string Текстовая информационная подсказка, выводимая слева от заголовка поля. + -
required string Является ли поле обязательным для заполнения. + -
defaultValue string Значение поля по-умолчанию. + -
displayOnlyText string Исключает все теги при показе содержимого компонента (например в таблице). + -
expandable string Требуется ли дополнительно запрашивать это поле у бекенда. + -
width integer Длина поля от 1 до 12 в единицах bootstrap-сетки. + -
multiple string Параметр отвечает за указание возможности поля принимать множественные значения. + -
readonly string Параметр указывает на запрет редактирования поля. + -
disabled string Флаг, позволяющий выводить значение без каких-либо элементов управления (только заголовок и значение). + -
multiname string Ключ, который будет использован для создания массива в запросе к бекенду в том случае, если поле работает в множественном режиме. Если ключ не установлен, то на бекенд отправится массив вида
['value1', 'value2', 'value3']. Если ключ установлен, например: multiname:"value", то на бекенд отправится массив вида [["value"=>"value1"], ["value"=>"value2"], ["value"=>"value3"]. + -
tinymce-init string Параметр-объект, который задает конфигурацию редактора (в программной реализации это объект который передается в функцию tinymce.init(), подробнее см. https://www.tinymce.com/docs/configure/integration-and-setup/#plugins) + -

В ключе plugins хранится перечень плагинов для mce. Библиотеки для них хранятся в /mce-files/plugins/.

Для подключения нового плагина использовать правило:

код плагина располагается по адресу /mce-files/plugins/plugin_name/plugin.min.js, где plugin_name – имя плагина, которое нужно прописать в параметре plugins через пробел.

В toolbarN (где N – номер панели, если отсчитывать сверху) перечисляются конкретные компоненты плагина, помещаемые на панели редактора.