@unplugstudio/droppy

Droppy

Simple, accessible, nested dropdow menus. Inspired by Bootstrap dropdowns.

Supports TAB navigation, Space/Enter to toggle the dropdowns, Esc to close. All positioning is done via CSS, so it can easily be converted to accordions / drawers for mobile users.

No dependencies. Less than 4 KB minified, less than 2 KB gzipped.

Open demo.html for a complete demo.

Installation

You can include Droppy directly in your document:

<script src="lib/droppy.min.js">
<script>
  droppy.Droppy(...)
  droppy.init(...)
<script>

You can also install from git and consume as a ES6 module:

npm install git+https://gitlab.com/jerivas/droppy.git

import Droppy, { init } from 'droppy'

Required markup

<button data-toggle="dropdown" aria-controls="dropdown-1">
  Open dropdown
</button>
<ul id="dropdown-1">
  <li><a href="#">Item 1</a></li>
  <li><a href="#">Item 2</a></li>
  <li><a href="#">Item 3</a></li>
</ul>

<script>
  // Single element
  var btn = document.querySelector('[data-toggle="dropdown"]')
  var myDroppy = new droppy.Droppy(btn)

  // OR: All elements with [data-toggle="dropdown"] in one go
  droppy.init()
</script>

• Add data-toggle="dropdown" to the button
• Add an id to the <ul> and pass it to aria-controls on the button
• Initialize Droppy on the button
• When the dropdown is toggled, the class open will be added to the dropdown (you can pass a custom class to init and Droppy as the second argument)
• Also the aria-expanded attribute will be toggled on the button
• Optional: Attach event listeners to the document and listen for:
  • show.droppy
  • shown.droppy
  • hide.droppy
  • hidden.droppy On each event you'll have access to the dropdown as event.target and the button as event.detail.relatedTarget