Пример
|
---|
BX.UI.Dialogs.MessageBox.show( { message: "Текст, поясняющий назначение данного попапа, находится здесь.", buttons: BX.UI.Dialogs.MessageBoxButtons.OK_CANCEL, popupOptions: { bindElement: BX("yesnocancel"), offsetLeft: 20, closeIcon: true, events: { onPopupClose: function() { BX.UI.Dialogs.MessageBox.alert("Попап закрыт."); } } } } ); |
Класс MessageBox
Описание и опции
Класс для создания стандартных информационных диалогов (alert и confirm).
new BX.UI.Dialogs.MessageBox( { options; } );
Опции объекта класса
options {object} — коллекция опций диалога. Список опций диалога в таблице:
Опция диалога | Тип | Описание |
---|---|---|
message | string|Element|Node | Сообщение диалога. Строка HTML или DOM-элемент. |
title | string | Заголовок диалога. |
modal | boolean | Если задано значение true, диалог откроется с оверлеем. |
cacheable | boolean | По умолчанию после закрытия диалог уничтожается из DOM. Это можно отменить, если задать cacheable: false . |
minWidth | number | Минимальная ширина окна. |
minHeight | number | Минимальная высота окна. |
maxWidth | number | Максимальная ширина окна. |
onOk | Function | Функция-обработчик кнопки OK. |
onCancel | Function | Функция-обработчик кнопки Отмена. |
onYes | Function | Функция-обработчик кнопки Да. |
onNo | Function | Функция-обработчик кнопки Нет. |
okCaption | string | Надпись кнопки OK. |
cancelCaption | string | Надпись кнопки Отмена. |
yesCaption | string | Надпись кнопки Да. |
noCaption | string | Надпись кнопки Нет. |
mediumButtonSize | boolean | По умолчанию кнопки диалога имеют маленький размер.
Если параметр mediumButtonSize задан в true, размер кнопок станет стандартным (medium).
Если задан параметр title , свойство mediumButtonSize автоматически устанавливается в true
(отменить это поведение можно через mediumButtonSize: false) . |
buttons | MessageBoxButtons | Array | Задает набор кнопок диалога. Структура MessageBoxButtons определяет следующие стандартные наборы:
|
popupOptions | object | Набор опций для BX.PopupWindow. |
Методы
Метод | Описание |
---|---|
messageBox.show | Показывает диалог на странице. |
messageBox.close | Закрывает диалог на странице. |
messageBox.getPopupWindow | Возвращает объект BX.PopupWindow. |
messageBox.setMessage | Устанавливает контент диалога. Строка HTML или DOM-элемент. |
messageBox.getMessage | Возвращает контент диалога. |
messageBox.setTitle | Устанавливает заголовок диалога. |
messageBox.getTitle | Возвращает заголовок диалога. |
messageBox.getOkButton | Возвращает кнопку ОК (объект класса BX.UI.Button). |
messageBox.getCancelButton | Возвращает кнопку Отмена (объект класса BX.UI.Button). |
messageBox.getYesButton | Возвращает кнопку Да (объект класса BX.UI.Button). |
messageBox.getNoButton | Возвращает кнопку Нет (объект класса BX.UI.Button). |
messageBox.setButtons | Устанавливает набор кнопок диалога. Набор задается структурой MessageBoxButtons или массивом объектов BX.UI.Button.
|
messageBox.getButtons | Возвращает массив кнопок диалога. |
messageBox.setOkCaption | Устанавливает надпись кнопки ОК. |
messageBox.setCancelCaption | Устанавливает надпись кнопки Отмена. |
messageBox.setYesCaption | Устанавливает надпись кнопки Да. |
messageBox.setNoCaption | Устанавливает надпись кнопки Нет. |
messageBox.setOkCallback | Устанавливает обработчик кнопки ОК. |
messageBox.setCancelCallback | Устанавливает обработчик кнопки Отмена. |
messageBox.setYesCallback | Устанавливает обработчик кнопки Да. |
messageBox.setNoCallback | Устанавливает обработчик кнопки Нет. |
MessageBox.create | Статический метод создания диалога.
options {object} — набор опций диалога (описание опций см. в new MessageBox). |
MessageBox.show | Создает и показывает диалог на странице.
options {object} — набор опций диалога (описание опций см. в new MessageBox). |
MessageBox.alert | Статический метод для создания информационных диалогов (alert).
alert(message: string | Element | Node, okCallback?: Function, okCaption?: string); alert(message: string | Element | Node, title?: string, okCallback?: Function, okCaption?: string); |
MessageBox.confirm | Статический метод для создания диалогов подтверждений (confirm).
confirm(message: string | Element | Node, okCallback?: Function, okCaption?: string, cancelCallback?: Function); confirm(message: string | Element | Node, title: string, okCallback?: Function, okCaption?: string, cancelCallback?: Function); |
Примеры
Создание объекта класса
const messageBox = new BX.UI.Dialogs.MessageBox( { message: "Вы действительно хотите удалить файл?", title: "Подтверждение удаления", buttons: BX.UI.Dialogs.MessageBoxButtons.OK_CANCEL, okCaption: "Да", onOk: function() { console.log("onOk"); }, } ); messageBox.show();
Произвольные названия и callback'и кнопок
const messageBox = new BX.UI.Dialogs.MessageBox( { message: "Разные названия кнопкам", title: "Подтверждение удаления", buttons: BX.UI.Dialogs.MessageBoxButtons.YES_NO_CANCEL, yesCaption: "Мое название Да", noCaption: "Мое название Нет", cancelCaption: "Моя Отмена", maxWidth: 600, onYes: function() { console.log("onYes"); messageBox.close(); }, onNo: function() { console.log("onNo"); messageBox.close(); }, onCancel: function(messageBox) { console.log("onCancel"); messageBox.close(); }, } ); messageBox.show();
Опции для BX.PopupWindow
BX.UI.Dialogs.MessageBox.show({ message: "Текст, поясняющий назначение данного попапа, находится здесь.", buttons: BX.UI.Dialogs.MessageBoxButtons.OK_CANCEL, popupOptions: { bindElement: BX("yesnocancel"), offsetLeft: 20, closeIcon: true, events: { onPopupClose: function() { BX.UI.Dialogs.MessageBox.alert("Попап закрыт."); } } } });
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.