Документация для разработчиков
Темная тема

CommentEditor

Описание и методы

Класс для редактирования комментариев в таймлайне.

BX.UI.Timeline.CommentEditor

Является наследником абстрактного редактора.

Сам объект не делает никаких ajax-запросов. Он только занимается отрисовкой и отправкой событий.

Метод Описание С версии
constructor(params: {})Конструктор.

Параметры:

  • params - параметры редактора
    • id - идентификатор редактора;
    • commentId - идентификатор комментария, если редактор должен изменить существующий.
getVisualEditorName(): stringМетод вернет название для объекта визуального редактора.
getTextarea(): ?HTMLTextAreaElementМетод вернет textarea, где хранится текст комментария, если редактор был отрисован.
renderTextarea(): HTMLTextAreaElementМетод отрисует textarea.
getVisualEditorContainer(): ?ElementМетод вернет DOM-элемент с визуальным редактором, если он есть.
renderVisualEditorContainer(): ElementМетод отрисует DOM-элемент для визуального редактора и вернет его.
getButtonsContainer(): ?ElementМетод вернет DOM-элемент с кнопками, если он есть.
renderButtons(): ElementМетод отрисует DOM-элемент с кнопками и вернет его.
showVisualEditor()Метод загрузит, если нужно, визуальный редактор через аякс и покажет его.
loadVisualEditor(): PromiseМетод вернет Promise, который будет разрешен после окончания загрузки редактора.
showEditorLoader()Показывает лоадер загрузки визуального редактора.
hideEditorLoader()Скрывает лоадер загрузки визуального редактора.
hideVisualEditor()Скрывает визуальный редактор.
save()Метод сохранит данные из редактора. Вызывается при клике на кнопку сохранения.
cancel()Метод сбрасывает состояние редактора до исходного. Вызывается при клике на кнопку отмены.
getEmptyMessageNotification(): PopupВозвращает попап о пустом значении.
refresh()Метод сбросит состояние редактора в исходное состояние.
getAttachments(): ArrayМетод вернет массив с идентификаторами прикрепленных файлов.

События

Событие Описание
namespace: BX.UI.Timeline.CommentEditor
errorСобытие бросается при возникновении ошибки, в message будет находиться текст.
  • message - сообщение об ошибке.
onLoadVisualEditorЭто асинхронное событие. Бросается при необходимости отображения визуального редактора. После разрешения Promise в data события по ключу html должен находиться html-код визуального редактора.
  • name - имя визуального редактора;
  • commentId - идентификатор комментария.
beforeSaveЭто событие бросается перед сохранением комментария. Если присвоить isCancel значение true, то сохранение будет отменено.
  • description - текст;
  • isCancel - флаг отмены;
  • files - идентификаторы файлов.
onSaveЭто асинхронное событие. Бросается на сохранении комментария. После разрешения Promise в data события по ключу comment должны быть данные для создания элемента Comment.
  • description - текст;
  • files - идентификаторы файлов;
  • commentId - идентификатор комментария.
afterSaveСобытие бросается после сохранения комментария.
  • comment - данные для создания элемента Comment.
cancelСобытие бросается при клике на кнопку Отмена.


© «Битрикс», 2001-2024, «1С-Битрикс», 2024