vanilla-hamburger is a port of hamburger-react to vanilla Custom Elements.

• Small: Just 1,6 KB (minified and gzipped). Size Limit controls the size.
• Fast: Built with standards based Custom Elements.
• Bulletproof: Written in strict TypeScript and covered by 20+ tests.
• Framework-agnostic: Can be used with any framework.
• No dependencies

• Website
• Angular example
• LitElement example
• React example
• Svelte example
• Vue example

npm install vanilla-hamburger --save

Or use one of the following content delivery networks:

unpkg.com CDN:

<script type="module" src="https://unpkg.com/vanilla-hamburger?module"></script>

Skypack CDN:

<script type="module" src="https://cdn.skypack.dev/vanilla-hamburger"></script>

<tilt-burger size="lg" aria-label="Toggle"></tilt-burger>
<script type="module">
  import 'vanilla-hamburger';

  const burger = document.querySelector('tilt-burger');
  burger.addEventListener('pressed-changed', (event) => {
    const pressed = event.detail.value;
  });
</script>

vanilla-hamburger provides 13 separate elements for different hamburger types.

When using one hamburger, ~1.6 KB will be added to your bundle (min + gzip).

The following properties can be used to customize hamburger elements:

Note: direction property is not supported by <squash-burger> and <squeeze-burger>.

vanilla-hamburger exposes CSS Shadow Parts allowing to override the default styles:

cross-burger {
  color: #999;
  outline: none;
}

cross-burger::part(bar) {
  border-radius: 9em;
}

cross-burger::before {
  position: absolute;
  content: '';
  top: 0;
  left: 0;
  width: 100%;
  height: 100%;
  border-radius: 50%;
  opacity: 0;
  background-color: currentColor;
  transition: opacity 0.5s;
}

cross-burger:hover::before,
cross-burger:focus::before {
  opacity: 0.08;
  transition-duration: 0.2s;
}

vanilla-hamburger provides a set of base classes that can be imported without registering custom elements. This is useful if you want to create your own hamburger icon with a different tag name.

import { Cross } from 'vanilla-hamburger/lib/entrypoints/cross.js';

customElements.define('custom-burger', class extends Cross {});

It is recommended to have a tap/click area of at least 48x48 pixels. Therefore, padding will be added around the icon to create a surface of exactly this size.

Keyboard interaction is provided with the enter key, and the icon element has the recommended accessibility attributes (such as role and aria-pressed).

Remember to use aria-label attribute to provide an accessible label for the icon.

vanilla-hamburger supports TypeScript and ships with types in the library itself; no need for any other install.

All the included custom elements are compatible with lit-analyzer and lit-plugin extension for Visual Studio Code, so you can benefit from type checking in lit-html templates.

vanilla-hamburger uses Custom Elements and Shadow DOM, and does not support IE11 or legacy Edge.

vanilla-hamburger has all the benefits of hamburger-react with one important difference.

While hamburger-react does not have direct dependencies, it still expects you to use React. This means that Angular, Vue, Svelte or vanilla JS users would have an extra dependency in their apps.

Now when all the evergreen browsers support standards based Custom Elements, it's perfect time to build such tiny and lightweight UI controls as web components rather than framework components.