BX.SidePanel.Instance

• contentCallback {function(BX.SidePanel.Slider)} - Функция-callback, загружающая в слайдер произвольное содержимое. В первом аргументе принимает объект слайдера (экземпляр класса BX.SidePanel.Slider). Callback должен внутри себя:
  • Создать и вернуть промис (new Promise(function(resolve, reject) {})).
  • Разрешить его (resolve(content)) с содержимым слайдера с содержимым слайдера (строка или DOM-элемент).
  • В случае ошибки сообщить об этом (reject(error)).
• width {number} - Максимальная ширина слайдера.
• cacheable {boolean} - Кешировать слайдер после закрытия. Если указано false, при закрытии слайдер будет автоматически уничтожен. По умолчанию true.
• autoFocus {boolean} - При открытии слайдера происходит автоматическая фокусировка на iframe'е. Это поведение можно отменить, если указать false.
• allowChangeHistory {boolean} - Менять адрес страницы на адрес открытого слайдера. По умолчанию true.
• allowChangeTitle {true|false|null} - Менять заголовок страницы на заголовок открытого слайдера. По умолчанию null. При не установленном значении (null), название страницы будет меняться, если у слайдера явно задан заголовок (опция title) или разрешена смена адреса страницы (allowChangeHistory).
Новое!

Опубликовано 28 03 2024г.

allowCrossOrigin {true|false|null} - Открывать сторонние сайты в слайдере.

• Для открытия внешнего сайта передать true. BX.SidePanel.Instance.open('http://testfiles.a-team.bx/demo/sidepanel.php?forceLoad=y', {cacheable: false, allowCrossOrigin: true})
• Для того, чтобы закрыть слайдер изнутри, то есть инициировать во внешнем сайте, нужно выполнить такой код:

  if (window.parent)
  {
      parent.postMessage('BX:SidePanel:close', document.referrer);
  }
  

• Чтобы просигнализировать слайдеру, что не нужно показывать лоадер до загрузки всех ресурсов, а показать по мере готовности:

  if (window.parent)
  {
      parent.postMessage('BX:SidePanel:load:force', document.referrer);
  }

• Если нужно из стороннего сайта отправить данные на портал:

  if (window.parent)
  {
      parent.postMessage({type: 'BX:SidePanel:data:send', data: {key1: 'data 1', key2: 'data 2'}}, document.referrer);
  }

• Чтобы портал мог получить эти данные, нужно добавить обработчик события onXDomainMessage при вызове слайдера

  BX.SidePanel.Instance.open(
      'https://cross-domain',
      {
          cacheable: false,
          allowCrossOrigin: true,
          events: {
              onXDomainMessage: (event: BX.SidePanel.MessageEvent) => {
                  const { command } = event.getData();
                  if (command === 'showHelper')
                  {
                      BX.Helper.show();
                  }
              }
          }
      }
  )

• Title {string} - Заголовок страницы. Если не указан, значение берется из document.title.
• requestMethod {string} - Если параметр равен post, то в iframe'е слайдера страница загрузится HTTP-методом POST. Это может понадобится для передачи большого объема данных, так как HTTP-метод GET может привести к ошибке 414 Request-URI Too Large.
• requestParams {object} - POST-параметры передаваемые в запросе. Имеет смысл только при requestMethod="post".
• loader {string} - Идентификатор лоадера вида moduleId:loaderId или путь к svg-файлу.
• data {object} - Произвольный набор своих данных для слайдера, с которыми можно работать (чтение/запись/удаление) на всем жизненном цикле.
• label {object} - Опция задает настройки для внешнего вида лейбла ("этикетки") слайдера. Объект вида:
  

  label: {
  	text: "Моя этикетка",
  	color: "#FFFFFF", //цвет текста
  	bgColor: "#2FC6F6", //цвет фона
  	opacity: 80 //прозрачность фона
  }

• animationDuration {number} - Время анимации открытия/закрытия слайдера в миллисекундах.
• events {object.} - Коллекция обработчиков событий.

• rules {Array} - Массив правил. Каждое правило - объект со следующими ключами:
  • condition {string[]|RegExp[]} - Массив шаблонов (регулярных выражений) ссылок. Обязательный параметр.
  • options {Object} - Коллекция опций, с которыми откроется слайдер. См. BX.SidePanel.Instance.open.
  • stopParameters {string[]} - Массив запрещенных параметров. Если адрес содержит хотя бы один из этих параметров, ссылка обработана не будет. Необязательный параметр.
  • handler {function(event, link)} - Функция-обработчик нажатия на ссылку. С помощью этого параметра можно переопределить поведение по умолчанию (открытие слайдера). Необязательный параметр.
    • event {MouseEvent} - Объект события нажатия на ссылку
    • link - Объект с данными ссылки:
      • href - Адрес ссылки.
      • target - Значение атрибута target.
      • anchor - DOM-объект ссылки (тег <a>).
      • matches - Массив с совпадениями групп регулярного выражения.
  • validate {function(link)} - Функция проверки корректности ссылки. Если возвращает false, ссылка обработана не будет. Необязательный параметр.
    • link - объект с данными ссылки.
  • allowCrossDomain {boolean} Разрешить открывать ссылки с внешних сайтов. По умолчанию false.
  • mobileFriendly {boolean} Обрабатывать ссылки в мобильных браузерах. По умолчанию false.

BX.SidePanel.Instance.isOpen()

BX.SidePanel.Instance.close([immediately=false])

BX.SidePanel.Instance.closeAll([immediately=false])

BX.SidePanel.Instance.destroy(url)

BX.SidePanel.Instance.reload()

BX.SidePanel.Instance.getTopSlider()

BX.SidePanel.Instance.getSlider(url)

BX.SidePanel.Instance.getSliderByWindow(window)

BX.SidePanel.Instance.getOpenSliders()

BX.SidePanel.Instance.getLastOpenSlider()