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

BX.SpotLight

new BX.SpotLight(
	options
)

Функция - конструктор.

Параметры Описание С версии
options {Object} Коллекция опций. Возможные значения:
  • targetElement {Element|string} - Элемент, около которого отобразится пульсирующий круг. Обязательная опция. Значением является либо ссылка на DOM-элемент, либо id-атрибут DOM-элемента, либо селектор для поиска через document.querySelector.
  • targetVertex {string} - Вершина элемента targetElement, относительно которой будет позиционироваться Spotlight. Допустимые значения:
    • top-left- Верхний левый угол. Значение по умолчанию.
    • top-center- Центральная точка верхней границы.
    • top-right- Верхний правый угол.
    • middle-left- Центральная точка левой границы.
    • middle-center- Центральная точка элемента.
    • middle-right- Центральная точка правой границы.
    • bottom-left- Нижный левый угол.
    • bottom-center- Центральная точка нижней границы.
    • bottom-right - Нижний правый угол.
  • content {Element|string} - Содержимое всплывающего диалога. Строка или DOM-элемент. Если этот параметр не указан, диалог показан не будет.
  • id {string} - Идентификатор подсказки. Необязательный параметр. Используется для сохранения факта просмотра пользователем подсказки.
  • top {number} - Смещение в пикселях относительно точки позиционирования targetVertex по оси ординат. По умолчанию 0.
  • left {number} - Смещение в пикселях относительно точки позиционирования targetVertex по оси абсцисс. По умолчанию 0.
  • lightMode {boolean} - Светлый режим показа Spotlight. Если указано true, пульсирующий круг будет белого цвета.
  • zIndex {number} - Z-index пульсирующего круга. По умолчанию 1001.
  • autoSave {boolean} - Если указано true, то после показа диалога с подсказкой, данный факт будет зафиксирован в опциях текущего пользователя. По умолчанию false.
  • observerTimeout {number} - Таймаут проверки изменений размеров и позиции элемента позиционарования targetElement. По умолчанию 1000.
  • events {object.} - Коллекция обработчиков событий.


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