react-burger-menu

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

Demo & examples

Live demo: negomi.github.io/react-burger-menu

To build the examples locally, run:

npm install
npm start

Then open localhost:8000 in a browser.

Tests

The test suite uses Mocha, Chai and Sinon, with jsdom.

You will need at least Node v4.0.0 (or io.js) to run the tests, due to jsdom depending on it.

To run the tests once, run:

npm test

To run them with a watcher, TDD style, run:

npm run tdd

Installation

The easiest way to use react-burger-menu is to install it from npm and include it in your own React build process (using Browserify, Webpack, etc).

WARNING: Elastic and Bubble are not currently supported with Webpack builds due to their Snap.svg dependency.

You can also use the standalone build by including dist/react-burger-menu.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

If you're using React 0.14+:

npm install react-burger-menu --save

If you're using React 0.13.3:

npm install react-burger-menu@1.1.6 --save

Usage

Items for the sidebar should be passed as child elements of the component using JSX.

If you're using this component with react-router, check out this info in the wiki.

1var Menu = require('react-burger-menu').nameOfAnimation;
2
3var Example = React.createClass({
4  showSettings: function(event) {
5    event.preventDefault();
6    .
7    .
8    .
9  },
10  render: function() {
11    return (
12      <Menu>
13        <a id="home" className="menu-item" href="/">Home</a>
14        <a id="about" className="menu-item" href="/about">About</a>
15        <a id="contact" className="menu-item" href="/contact">Contact</a>
16        <a onClick={ this.showSettings } className="menu-item--small" href="">Settings</a>
17      </Menu>
18    );
19  }
20});
21

Animations

• slide
• stack
• elastic
• bubble
• push
• pushRotate
• scaleDown
• scaleRotate
• squeeze
• fallDown

Properties

Some animations require certain other elements to be on your page:

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

  1<Menu pageWrapId={ "page-wrap" } />
  2<main id="page-wrap">
  3  .
  4  .
  5  .
  6</main>

• Outer container - an element containing everything, including the menu component

  1<div id="outer-container">
  2  <Menu pageWrapId={ "page-wrap" } outerContainerId={ "outer-container" } />
  3  <main id="page-wrap">
  4    .
  5    .
  6    .
  7  </main>
  8</div>

If you are using an animation that requires either/both of these elements, you need to give the element an ID, and pass that ID to the menu component as the pageWrapId and outerContainerId props respectively.

Check this table to see which animations require these elements:

Animation	pageWrapId	outerContainerId
slide
stack
elastic	✓	✓
bubble
push	✓	✓
pushRotate	✓	✓
scaleDown	✓	✓
scaleRotate	✓	✓
squeeze	✓	✓
fallDown	✓	✓

Additionally squeeze animation accepts breakpoint prop, which describes the point in viewport width, where there is no longer desired to content to shrink. Its default value is 960, but this can be controlled:

<Menu breakpoint={ 660 } />

Position

The menu opens from the left by default. To have it open from the right, use the position prop. It's just a strin with 3 possible values: left, right, bottom so you don't need to specify a value. Then set the position of the button using CSS.

1<Menu position='right' />

Width

You can specify the width of the menu (in pixels) with the width prop. The default is 300.

1<Menu width={ 280 } />

Height

When used with position='bottom' height can be passed to component (default is 350px).

1<Menu height={ 600 } />

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.

1<Menu isOpen />

State change

You can detect whether the sidebar is open or closed by passing a callback function to onStateChange. The callback will receive an object containing the new state as its first argument.

1var isMenuOpen = function(state) {
2  return state.isOpen;
3};
4
5<Menu onStateChange={ isMenuOpen } />

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.

1<Menu disableCloseOnEsc />

Custom window.onkeydown handler

For more control over global keypress functionality, you can override the handler that this component sets for window.onkeydown, and pass a custom function. This could be useful if you are using multiple instances of this component, for example, and want to implement functionality to ensure that a single press of the Escape key closes them all.

1const closeAllMenusOnEsc = (e) => {
2  e = e || window.event;
3
4  if (e.key === 'Escape' || e.keyCode === 27) {
5    this.setState({areMenusOpen: false});
6  }
7};
8
9// Because we can only set one window.onkeydown handler, the last menu you include will override any handlers set by previous ones.
10// For that reason, it's recommended that you pass the same function to all menus to avoid unexpected behavior.
11<MenuOne customOnKeyDown={closeAllMenusOnEsc} isOpen={areMenusOpen} />
12<MenuTwo customOnKeyDown={closeAllMenusOnEsc} isOpen={areMenusOpen} />

Note: Using this prop will disable all the default 'close on Escape' functionality, so you will need to handle this (including determining which key was pressed) yourself.

Overlay

You can turn off the default overlay with noOverlay.

1<Menu noOverlay />

Custom icons

You can replace the default bars that make up the burger and cross icons with custom ReactElements. Pass them as the customBurgerIcon and customCrossIcon props respectively.

1<Menu customBurgerIcon={ <img src="img/icon.svg" /> } />
2<Menu customCrossIcon={ <img src="img/cross.svg" /> } />

You should adjust their size using the .bm-burger-button and .bm-cross-button classes, but the element itself will have the class .bm-icon or .bm-cross if you need to access it directly.

You can also disable the icon elements so they won't be included at all, by passing false to these props.

1<Menu customBurgerIcon={ false } />
2<Menu customCrossIcon={ false } />

This can be useful if you want exclusive external control of the menu, using the isOpen prop.

Custom ID

There is also an optional id prop, which will simply add an ID to the rendered menu's outermost element. This is not required for any functionality.

1<Menu id={ "sidebar" } />

Styling

All the animations are handled internally by the component. However, the visual styles (colors, fonts etc.) are not, and need to be supplied, either with CSS or with a JavaScript object passed as the styles prop.

CSS

The component has the following helper classes:

1/* Position and sizing of burger button */
2.bm-burger-button {
3  position: fixed;
4  width: 36px;
5  height: 30px;
6  left: 36px;
7  top: 36px;
8}
9
10/* Color/shape of burger icon bars */
11.bm-burger-bars {
12  background: #373a47;
13}
14
15/* Position and sizing of clickable cross button */
16.bm-cross-button {
17  height: 24px;
18  width: 24px;
19}
20
21/* Color/shape of close button cross */
22.bm-cross {
23  background: #bdc3c7;
24}
25
26/* General sidebar styles */
27.bm-menu {
28  background: #373a47;
29  padding: 2.5em 1.5em 0;
30  font-size: 1.15em;
31}
32
33/* Morph shape necessary with bubble or elastic */
34.bm-morph-shape {
35  fill: #373a47;
36}
37
38/* Wrapper for item list */
39.bm-item-list {
40  color: #b8b7ad;
41  padding: 0.8em;
42}
43
44/* Styling of overlay */
45.bm-overlay {
46  background: rgba(0, 0, 0, 0.3);
47}

JavaScript

The same styles can be written as a JavaScript object like this:

1var styles = {
2  bmBurgerButton: {
3    position: 'fixed',
4    width: '36px',
5    height: '30px',
6    left: '36px',
7    top: '36px'
8  },
9  bmBurgerBars: {
10    background: '#373a47'
11  },
12  bmCrossButton: {
13    height: '24px',
14    width: '24px'
15  },
16  bmCross: {
17    background: '#bdc3c7'
18  },
19  bmMenu: {
20    background: '#373a47',
21    padding: '2.5em 1.5em 0',
22    fontSize: '1.15em'
23  },
24  bmMorphShape: {
25    fill: '#373a47'
26  },
27  bmItemList: {
28    color: '#b8b7ad',
29    padding: '0.8em'
30  },
31  bmOverlay: {
32    background: 'rgba(0, 0, 0, 0.3)'
33  }
34}

<Menu styles={ styles } />

Server-side rendering

This component uses Radium to manage its internal styles, which also handles vendor prefixing. In universal/isomorphic applications, you need to pass the user agent to the component via the radiumConfig prop so Radium knows which prefixes to apply.

This is an example of how that would look using Express:

1<Menu radiumConfig={{userAgent: req.headers['user-agent']}} />

Browser support

Because this project uses CSS3 features, it's only meant for modern browsers. Some browsers currently fail to apply some of the animations correctly.

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

Help

Check the FAQ (https://github.com/negomi/react-burger-menu/wiki/FAQ) to see if your question has been answered already, or open a new issue.

License

MIT

Updating and publishing npm package

https://docs.npmjs.com/getting-started/publishing-npm-packages

After the package get published for the first time, further updates are being done as follows:

• npm run build to build package for publishing
• commit all changes to git, which will clear the project tree
• npm version patch for small changes (this should be done in semver way - https://docs.npmjs.com/getting-started/semantic-versioning, 3 options here are: major, minor, patch, )
• npm publish (this creates new tag in git)