pmx-dropdown-menu

Module to generate an dropdown menu

Usage no npm install needed!

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

README

PMX Dropdown Menu:

Intro

Module to generate an accordion menu

Getting Started

import EventEmitter from 'eventemitter3';
import dropdown from 'pmx-dropdown-menu';

const emitter = new EventEmitter();
const dd = dropdown();
const el = document.getElementById('example-dropdown');
const config = {
  el,
}
const shared = {
  emitter,
};
dd.init(config, shared);

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-dropdown-menu

or using NPM

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

CommonJS

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

ES2015 modules

import inert from 'pmx-dropdown-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

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

  • Map
  • Object.assign