Документация

Инсталляция

Скачайте архив или используйте CDN-ссылку для импорта плагина в Ваш проект:

<script src="https://cdn.jsdelivr.net/gh/FranzZZz1/DynamicHeaderCDN@eighteenth/dynamicHeader.js"></script>

Начало работы

HTML-разметка

Данная разметка является примером.

Классы, порядок расположения и количество элементов могут быть изменены в зависимости от требований Вашего проекта.

<header class="header">
  <div class="header__container">
    <a href="#" class="header__logo">
      <img src="" alt="" />
    </a>
    <div class="header__menu-wrapper">
      <nav class="header__menu">
        <ul class="header__menu-list">
          <li class="header__menu-item">
            <a href="#" class="header__menu-link">
              Menu-item
            </a>
          </li>
          <li class="header__menu-item">
            <a href="#" class="header__menu-link">
              Menu-item
            </a>
          </li>
        </ul>
      </nav>
    </div>
    <button class="header__burger">
      <span></span>
    </button>
  </div>
</header>

JavaScript инициализация

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

const dh = new DynamicHeader(".header", {
  menuIcon: ".header__burger",
  menuBody: ".header__menu-wrapper",
  menuItem: ".header__menu-item",
  menuLink: ".header__menu-link"
});

Параметры

header

По умолчанию: "header"

Основной элемент плагина Dynamic Header. Именно его Вам предстоит кастомизировать с помощью параметров.

menuIcon

По умолчанию: ".header__burger"

Элемент, при нажатии на который происходит открытие и закрытие меню.

menuBody

По умолчанию: ".header__menu-wrapper"

Элемент menuBody содержит все основные элементы навигации, в данном случае якорные ссылки.

menuItem

По умолчанию: ".header__menu-item"

Элемент списка меню(тег li), в котором находится якорная ссылка.

menuLink

По умолчанию: ".header__menu-link"

Элемент, с помощью которого происходит навигация между элементами страницы, он же якорная ссылка.

mainElement

По умолчанию: false

Параметр предназначен для добавления верхнего отступа элементу "main", равному высоте шапки сайта, когда она находится в фиксированной позиции, или добавления нижнего отступа элементу "header", равного "mainElementScrollMargin" когда позиция не фиксированная.

mainElementScrollMargin

По умолчанию: 0

Параметр предназначен для добавления отступа между элементами "main" и "header".

scrollMargin

По умолчанию: 0

Число, с помощью которого можно указать дополнительный отступ между шапкой сайта и секцией при навигации по якорным ссылкам.