@kanety/stimulus-menu v1.2.0

stimulus-menu

A stimulus controller for simple menu.

Dependencies

• @hotwired/stimulus 3.0+

Installation

Install from npm:

$ npm install @kanety/stimulus-menu --save

Usage

Register controller:

import { Application } from '@hotwired/stimulus';
import MenuController from '@kanety/stimulus-menu';

const application = Application.start();
application.register('menu', MenuController);

Import css:

@import '@kanety/stimulus-menu';

Build html as follows:

<ul class="st-menu st-menu--horizontal" data-controller="menu">
  <li>
    <span class="st-menu__icon"><a href="#">Menu1</a></span>
    <ul class="st-menu--vertical">
      <li><a href="#">Menu1-1</a></li>
      <li><a href="#">Menu1-2</a></li>
      <li><a href="#">Menu1-3</a></li>
    </ul>
  </li>
  <li>
    <span class="st-menu__icon"><a href="#">Menu2</a></span>
    <ul class="st-menu--vertical">
      <li><a href="#">Menu2-1</a></li>
      <li><a href="#">Menu2-2</a></li>
      <li><a href="#">Menu2-3</a></li>
    </ul>
  </li>
</ul>

You can also build vertical menu as follows:

<!-- set st-menu--vertial -->
<ul class="st-menu st-menu--vertical" data-controller="menu">
  <li>
    <span class="st-menu__icon"><a href="#">Menu1</a></span>
    <ul class="st-menu--vertical">
      <li><a href="#">Menu1-1</a></li>
      <li><a href="#">Menu1-2</a></li>
      <li><a href="#">Menu1-3</a></li>
    </ul>
  </li>
  <li>
    <span class="st-menu__icon"><a href="#">Menu2</a></span>
    <ul class="st-menu--vertical">
      <li><a href="#">Menu2-1</a></li>
      <li><a href="#">Menu2-2</a></li>
      <li><a href="#">Menu2-3</a></li>
    </ul>
  </li>
</ul>

Options

auto-open

Open menu by mouse hovering:

<ul data-controller="menu"
    data-menu-auto-open-value="true">
</ul>

keep-open

Keep menu opened after clicking menu items:

<ul data-controller="menu"
    data-menu-keep-open-value="true">
</ul>

toggle-element

You can change toggle element (default is a). For example:

<ul data-controller="menu"
    data-menu-toggle-element-value="button">
  <li><button type="button">Button</button></li>
</ul>

Callbacks

Set callbacks fired when a menu item is opened / closed:

let element = document.querySelector('[data-controller="menu"]');
element.addEventListener('menu:opened', (e) => {
  console.log('opened: ' + e.detail.item.querySelector('a').href);
});
element.addEventListener('menu:closed', (e) => {
  console.log('closed: ' + e.detail.item.querySelector('a').href);
});

License

The library is available as open source under the terms of the MIT License.