Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 1.51 KB

single-level-menu-with-toggle.md

File metadata and controls

42 lines (35 loc) · 1.51 KB

Single-level menu with toggle

A single-level menu with a toggle is the most common type of menu that can be used with accessible-menu-bootstrap-4.

An example of this kind of menu is as follows:

<nav id="main-nav" aria-label="Main" class="navbar navbar-expand-lg">
  <button id="main-menu-toggle" aria-label="Toggle main menu" class="navbar-toggler">
    <span class="navbar-toggler-icon"></span>
  </button>
  <div class="collapse navbar-collapse">
    <ul id="main-menu" class="navbar-nav">
      <li class="nav-item">
        <a href="/about" class="nav-link">About</a>
      </li>
      <li class="nav-item">
        <a href="/projects" class="nav-link">Projects</a>
      </li>
      <li class="nav-item">
        <a href="/contact" class="nav-link">Contact me</a>
      </li>
    </ul>
  </div>
</nav>

Given the above structure, the parameters needed for an accessible menu are:

  • menuElement
  • controllerElement
  • containerElement

Depending on what kind of menu you'd like to create you can use Bootstrap4DisclosureMenu, Bootstrap4Menubar, or Bootstrap4Treeview.

const menu = new AccessibleMenuBootstrap4.Bootstrap4DisclosureMenu({
  menuElement: document.querySelector("#main-nav .navbar-nav"),
  controllerElement: document.querySelector("#main-nav .navbar-toggler"),
  containerElement: document.querySelector("#main-nav .navbar-collapse"),
});