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

Компонент bitrix:ui.tour

Данный компонент выводит подсказку на странице около указанного DOM-элемента DOM (от англ. Document Object Model — «объектная модель документа») — это независящий от платформы и языка программный интерфейс, позволяющий программам и скриптам получить доступ к содержимому HTML-, XHTML- и XML-документов, а также изменять содержимое, структуру и оформление таких документов.
Подробнее...
.

$APPLICATION->includeComponent("bitrix:ui.tour", "", array(
	"ID" => "my-tour1",
	"JS_OPTIONS" => array(
		"steps" => array(
			array(
				"target" => '#button',
				"title" => "Кнопка",
				"text" => "Данные попапы призваны помочь вам понять наш сложный продукт. Каждый день мы наполняем его новым функционалом, разобраться в котором не так просто.",
				"link" => "#",
			),
			array(
				"target" => '#text',
				"title" => "Текст",
				"text" => "Данные попапы призваны помочь вам понять наш сложный продукт. Каждый день мы наполняем его новым функционалом, разобраться в котором не так просто.",
			)
		),
	)
	))

ПараметрОписание
IDИдентификатор подсказки. Обязательный параметр.
USER_TYPEТип пользователя. Допустимые значения:
  • OLD – показ подсказки для старых пользователей
  • NEW – показ подсказки для новых пользователей
  • ALL – показ подсказки для любых пользователей
USER_TIMESPANПромежуток времени в секундах для определения нового/старого пользователя. По умолчанию 30 дней.
LIFETIMEВремя жизни подсказки в секундах. По умолчанию 30 дней.
START_DATEДата, с которой начнется показ тура. По умолчанию не задана.
END_DATEДата, до которой можно показывать тур. По умолчанию не задана.
JS_OPTIONSМассив опций для конструктора BX.UI.Tour.Guide.
AUTO_STARTСтарт тура при загрузке страницы. По умолчанию true. Если на странице расположено несколько компонентов bitrix:ui.tour с опцией "AUTO_START" => true (по умолчанию), то туры будут добавлены в очередь. Сначала запустится один тур, после его окончания - следующий тур, и так далее.
AUTO_START_TIMEOUTВремя в миллисекундах, на которое будет отложен старт тура.



Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх