pmx-accordion-menu

Module to generate an accordion menu

Usage no npm install needed!

<script type="module">
  import pmxAccordionMenu from 'https://cdn.skypack.dev/pmx-accordion-menu';
</script>

README

PMX Accordion Menu:

Intro

Module to generate an accordion menu

Getting Started

How to use

Setup

The module is exported as an UMD module so it can be used with AMD, CommonJS, ES Modules and in the browser.

  • Install the dependency Using Yarn
yarn add pmx-accordion-menu

or using NPM

npm install pmx-accordion-menu --save
  • Include the module

CommonJS

const inert = require('pmx-accordion-menu').default;

ES2015 modules

import inert from 'pmx-accordion-menu';

API

.init(config, shared):

Initializes the component.

.stop(config, shared)

Stops the component by removing all added mutations.

Browser Support

  • IE 10+
  • Chrome
  • Firefox
  • Safari

Dependencies

  • EventEmitter3: To be able to open/close the menu from another component by triggering an event

This library has been written with some ES2015 features that need to be polyfilled:

  • Map
  • Set
  • Array.from
  • Object.assign