npm package: @offlineagency/vue3-burger-menu
Description: [![npm](https://img.shields.io/npm/v/vue3-burger-menu.svg?cacheSeconds=3600)](https://www.npmjs.com/package/vue3-burger-menu)
Author: Offline Agency
Latest version: 1.0.0

# vue3-burger-menu [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![npm](https://img.shields.io/npm/v/vue3-burger-menu.svg?cacheSeconds=3600)](https://www.npmjs.com/package/vue3-burger-menu)

Updated to vue3 from the vue-burger-menu by Mohit Bajoria [`https://github.com/mbj36/vue-burger-menu`](https://github.com/mbj36/vue-burger-menu)

An off-canvas sidebar Vue component with a collection of effects and styles using CSS transitions and SVG path animations.

## Demo & examples

Live demo - https://vue3-burger-menu.netlify.app/

To build the examples locally, run:

```
npm i
npm run serve
```

```
yarn
yarn serve
```

Then open [`localhost:8083`](http://localhost:8083) in a browser

## Installation

```
npm install vue3-burger-menu --save
```

```
yarn add vue3-burger-menu
```

## Usage

Items should be passed as child elements of the components

```javascript
import { Slide } from 'vue3-burger-menu'  // import the CSS transitions you wish to use, in this case we are using `Slide`

export default {
    components: {
        Slide // Register your component
    }
}
```

In your template

```
<template>
    <Slide>
      <a id="home" href="#">
        <span>Home</span>
      </a>
    </Slide>
</template>
```

### Animations

The example above imported `slide` which renders a menu that slides in on the page when the burger icon is clicked. To use a different animation you can subsitute slide with any of the following

* Slide
* ScaleDown
* ScaleRotate
* Reveal
* Push
* PushRotate

ATTENTION - the below animations are in WIP

* FallDown
* Stack
* Elastic
* Bubble

### Properties

Some animation require certain other elements on your page

* Page wrapper - an element wrapping the rest of the content on yur page, placed after the menu component

```javascript
<Menu/>

<main id="page-wrap">
.
.
</main>

```

* Outer container called `app` - an element containing everything including the menu component

```javascript
<div id="app">
    <Menu/>
    <main id="page-wrap">
    .
    .
    .
    </main>
</div>
```

Check this table to see which animations require these elements:

Animation | `pageWrapId` | `appId`
--- | :---: | :---:
`Slide` | |
`Push` | &#x2713; | &#x2713;
`PushRotate` |  &#x2713;  |  &#x2713;
`ScaleDown` |  &#x2713;  |  &#x2713;
`ScaleRotate` |  &#x2713;  |  &#x2713;
`Reveal` |  &#x2713;  |  &#x2713;

### Position

The menu opens from left by default. To have it open from the right, use the `right` prop. It's just a boolean so you don't need to specify a value.

```javascript
<Slide right/>
```

### Width

You can specify the width of the menu with the `width` prop. The default is `300px`

```javascript
<Slide width="400">
```

### Open state

You can control whether the sidebar is open or closed with the `isOpen` prop. This is useful if you need to close the menu after a user clicks on an item in it, for example, or if you want to open the menu from some other button in addition to the standard burger icon. The default value is `false`

```javascript
// To render the menu open

<Slide isOpen >

ex:
<template>
  <button v-if="!isOpen" @click="isOpen=true">Open Menu</button>
  <Slide :isOpen="isOpen" @closeMenu="isOpen = false">
</template>

// Component
data() {
  return {
    isOpen: false
  }
}

```
### Menu events

If you want to get a notification when the menu open or close you can use the `openMenu` and `closeMenu` notifications. This way you can update your application state when the menu open or close

```javascript
// To bind the open and close events

<Slide
  @openMenu="handleOpenMenu"
  @closeMenu="handleCloseMenu"
>
```
### Close on Outside Click

You can turn off the menu closing when an an outside click is triggered with `disableOutsideClick`.

``` javascript
<Slide disableOutsideClick>
```

### Close on Escape

By default, the menu will close when the Escape key is pressed. To disable this behavior, you can pass the `disableCloseOnEsc` prop. This is useful in cases where you want the menu to be open all the time, for example if you're implementing a responsive menu that behaves differently depending on the browser width.

``` javascript
<Slide disableEsc />
```

### Close on Navigation

By default, the menu will not close when a link inside the menu is clicked. To disable this behavior, you can pass the `closeOnNavigation` prop. This is useful in cases where you want the menu to close when a navigation link is clicked as this then stops the user having to make an extra click to close the menu.

``` javascript
<Slide :closeOnNavigation="true" />
```

### Overlay

You can turn off the default overlay with `noOverlay`.

``` javascript
<Slide noOverlay />
```

### Burger Icon and Cross Icon

You can disable both icons by passing burgerIcon and crossIcon to `false`. This can be useful if you want to keep the menu open and don't want the user to close the menu

```javascript
<Slide :burgerIcon="false" :crossIcon="false"/>
```

### Styling

Visual styles (color, font etc) need to be supplied with the help of CSS

#### CSS
The component has following helper class

```CSS
 .bm-burger-button {
      position: fixed;
      width: 36px;
      height: 30px;
      left: 36px;
      top: 36px;
      cursor: pointer;
    }
    .bm-burger-bars {
      background-color: #373a47;
    }
    .line-style {
      position: absolute;
      height: 20%;
      left: 0;
      right: 0;
    }
    .cross-style {
      position: absolute;
      top: 12px;
      right: 2px;
      cursor: pointer;
    }
    .bm-cross {
      background: #bdc3c7;
    }
    .bm-cross-button {
      height: 24px;
      width: 24px;
    }
    .bm-menu {
      height: 100%; /* 100% Full-height */
      width: 0; /* 0 width - change this with JavaScript */
      position: fixed; /* Stay in place */
      z-index: 1000; /* Stay on top */
      top: 0;
      left: 0;
      background-color: rgb(63, 63, 65); /* Black*/
      overflow-x: hidden; /* Disable horizontal scroll */
      padding-top: 60px; /* Place content 60px from the top */
      transition: 0.5s; /*0.5 second transition effect to slide in the sidenav*/
    }

    .bm-overlay {
      background: rgba(0, 0, 0, 0.3);
    }
    .bm-item-list {
      color: #b8b7ad;
      margin-left: 10%;
      font-size: 20px;
    }
    .bm-item-list > * {
      display: flex;
      text-decoration: none;
      padding: 0.7em;
    }
    .bm-item-list > * > span {
      margin-left: 10px;
      font-weight: 700;
      color: white;
    }
```

## Browser Support

Chrome and Firefox have full support, but Safari and IE have strange behavior for some of the menus.

## Author

&#169; [Mohit Bajoria](https://mbj36.xyz)

Updated to vue3 by Michael Dillard

## License

[MIT](https://github.com/mbj36/vue3-burger-menu/blob/master/LICENSE)