## Table of Contents
- [Browser Support](#browser-support)
- [Installing](#installing)
- [Package manager](#package-manager)
- [CDN](#cdn)
- [Usage](#usage)
* [Stopping list opening on certain elements](#stopping-list-opening-on-certain-elements)
- [Options](#options)
- [API](#api)
+ [dispose](#dispose)
+ [update](#update)
- [Events](#events)
- [CSS custom properties (variables)](#css-custom-properties-variables)
- [Migrating to v1.0.3 from v1.4.0](#migrating-to-v103-from-v140)
- [Examples](#examples)
- [Demo](#demo)
- [About](#about)
* [Related projects](#related-projects)
* [Contributing](#contributing)
* [Author](#author)
* [License](#license)
## Browser Support
> This plugin does not support any version of IE browser.
 |  |  |  |  |  |
--- | --- | --- | --- | --- | --- |
Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | ❌ |
## Install
### Package Managers
Using [npm](https://www.npmjs.com/):
```bash
npm install metismenujs
```
Using [yarn](https://yarnpkg.com):
```sh
yarn add metismenujs
```
Using [pnpm](https://pnpm.io/):
```sh
pnpm add metismenujs
```
Once the package is installed, you can import the library using `import` or `require` approach:
```js
// recommended approach
import { MetisMenu } from 'metismenujs';
```
```js
// You can also use the default export
import MetisMenu from 'metismenujs';
```
If you use `require` for importing, **only default export is available**:
```js
const MetisMenu = require('metismenujs');
```
> **Note** CommonJS usage
> In order to gain the TypeScript typings (for intellisense / autocomplete) while using CommonJS imports with `require()`, add the following to your `tsconfig.json`:
```json
{
"compilerOptions": {
"moduleResolution": "NodeNext"
}
}
```
### CDN
#### ES6 UMD browser module
Using [jsDelivr](https://www.jsdelivr.com/) CDN:
```html
```
Using [unpkg](https://unpkg.com/) CDN:
```html
```
#### ES6 ES module
Using [jsDelivr](https://www.jsdelivr.com/) CDN:
```html
```
Using [unpkg](https://unpkg.com/) CDN:
```html
```
Install with [composer](https://getcomposer.org/)
```bash
composer require onokumus/metismenujs:dev-master
```
### Download
[download](https://github.com/onokumus/metismenujs/archive/master.zip)
Ready to use files are located in the `dist` directory.
## Usage
1. Include metismenujs StyleSheet
### Using CDN
[jsDelivr](https://www.jsdelivr.com/) :
```html
```
[unpkg](https://unpkg.com/) :
```html
```
### Using [Vite](https://vitejs.dev/), [Astro](https://astro.build/) etc.
```js
import 'metismenujs/style';
```
or sass source file
```js
import 'metismenujs/sass';
```
2. Add class `metismenu` to unordered list
```html
```
3. Make expand/collapse controls accessible
> Be sure to add `aria-expanded` to the element `a`. This attribute explicitly defines the current state of the collapsible element to screen readers and similar assistive technologies. If the collapsible element is closed by default, it should have a value of `aria-expanded="false"`. If you've set the collapsible element's parent `li` element to be open by default using the `active` class, set `aria-expanded="true"` on the control instead. The plugin will automatically toggle this attribute based on whether or not the collapsible element has been opened or closed.
```html