RD Navbar Documentation
Настройки скрипта
Обозначения для data атрибутов:
(*) - суффикс, определяющий для какого размера экрана будет определено свойство. Суффиксы:
-
- xs
- от 480px
-
- sm
- от 768px
-
- md
- от 992px
-
- lg
- от 1199px
Настройки
layout или data-(*)-layout
- Тип
- String
- Значение по-умолчанию
- 'rd-navbar-static'
Определяет тип лейаута навбара
deviceLayout или data-(*)-device-layout
- Тип
- String
- Значение по-умолчанию
- 'rd-navbar-fixed'
Определяет тип лейаута навбара для мобильных устройств
focusOnHover или data-(*)-hover-on
- Тип
- Boolean
- Значение по-умолчанию
- true
Включает/Отключает отображение подменю при ховере
focusOnHoverTimeout
- Тип
- String
- Значение по-умолчанию
- 800
Определяет время (мс) задержки автоматического скрытия подменю и ховер ауте.
linkedElements
- Тип
- Array
- Значение по-умолчанию
- ['html']
Определяет массив для создания линкованных элементов. В качестве значения элемента массива может быть как селектор так и HTML элемент. При изменении лейаута навбара, на каждый из залинкованных элементов будет навешиваться сооветствующий класс формата [layout]-linked.
domAppend
- Тип
- Boolean
- Значение по-умолчанию
- true
Флаг, отвечающий за автоматическое дополнение указанной HTML разметки навбара дополнительными служебными классами и элементами.
stickUp или data-(*)-stick-up
- Тип
- Boolean
- Значение по-умолчанию
- true
Флаг, отвечающий за прилипание панели при скролле.
stickUpClone
- Тип
- Boolean
- Значение по-умолчанию
- true
Определяет, какой элемент будет использоваться для создания эффекта прилипания при скролле: клон или оригинал.
stickUpOffset или data-(*)-stick-up-offset
- Тип
- Number|String
- Значение по-умолчанию
- '100%'
Определяет расстояние от начала навбара, при котором будет происходить залипание панели при скролле. Можно использовать как точное растояние, так и процент от высоты навбара.
anchorNav
- Тип
- Boolean
- Значение по-умолчанию
- false
Реализует якорную навигацию на странице.
anchorNavSpeed
- Тип
- Number
- Значение по-умолчанию
- 400
Определяет скорость движения при использовании одностраничной якорной навигации
anchorNavOffset
- Тип
- Number
- Значение по-умолчанию
- 0
Определяет дополнительное расстояние движения при использовании одностраничной якорной навигации. Можно использовать отрицательное значение.
anchorNavEasing
- Тип
- String
- Значение по-умолчанию
- 'swing'
Определяет название временной функции движения при использовании одностраничной навигации. Требует подключенного плагина jQuery Easing 1.1+.
autoHeight или data-(*)-auto-height
- Тип
- Boolean
- Значение по-умолчанию
- true
Определяет, будет ли просчитываться высота для rd-navbar-wrap.
responsive
- Тип
- Object
Объект, который используется для переопределения параметров по-умолчанию для специфических разрешений.
callbacks
- Тип
- Object
Объект, который используется для определений callback функций для определенных событий
События
Toggle Switched
- Callback
- OnToggleSwitch
Определяется при изменении состояния переключателя. Возвращает затронутый переключатель и контекст навбара
Toggle Closed
- Callback
- OnToggleClose
Определяется при деактивации переключателя. Возвращает затронутый переключатель и контекст навбара
Dom Appended
- Callback
- OnDomAppend
Определяется при дополнении указанной HTML разметки навбара дополнительными служебными элементами и классами. Возвращает контекст навбара.
Submenu Mouse Enter
- Callback
- OnDropdownOver
Определяется при наведении указателя мыши на пункт меню, содержащий подменю. Возращает затронутый пункт меню и контекст навбара.
Submenu Mouse Leave
- Callback
- OnDropdownOut
Определяется в случае, когда указатель мыши покидает пункт меню, содержащий подменю. Возращает затронутый пункт меню и контекст навбара.
Submenu Toggled
- Callback
- OnDropdownToggle
Определяется при активации/деактивации подменю. Возращает затронутый пункт меню и контекст навбара.
Submenu Closed
- Callback
- OnDropdownClose
Определяется при деактивации подменю. Возращает затронутый пункт меню и контекст навбара.
Navbar Sticked Up
- Callback
- OnStuck
Определяется при прилипании панели навбара.
Navbar Came Static
- Callback
- OnUnstuck
Определяется при переходе панели навбара в статический режим.
Anchor Changed
- Callback
- OnAnchorChange
Определяется при изменении текущего элемента одностраничной якорной навигации.