Button that invokes a command menu, usually in a mobile context

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent sit amet facilisis augue, sit amet dignissim felis. Curabitur in blandit justo. Duis ornare sem vitae enim feugiat, ultrices facilisis velit luctus. Aliquam porttitor sollicitudin nibh. Nulla lobortis quam venenatis, aliquam risus non, lacinia purus. Nulla a lectus non urna suscipit blandit id eget libero. Suspendisse ac bibendum arcu. Nunc consequat maximus aliquet. Nullam facilisis purus neque, sit amet egestas purus malesuada nec. In luctus tempus diam sit amet egestas.

Pellentesque ipsum dolor, consequat ut nunc at, congue semper nisl. Duis id cursus orci, sit amet sollicitudin libero. Proin a vehicula neque, eget placerat arcu. Nullam ultricies ullamcorper rutrum. Donec nunc augue, porttitor in metus sit amet, molestie egestas magna. Donec eget neque elementum, feugiat erat eu, sagittis felis. Quisque vitae urna rhoncus sapien condimentum suscipit. Cras luctus sollicitudin urna sit amet tincidunt. Suspendisse potenti. Fusce pretium libero et augue lobortis, quis iaculis est vehicula.

Nam varius et mauris dictum consectetur. Nulla venenatis, ante auctor scelerisque feugiat, nulla nisl elementum neque, nec facilisis quam erat eu orci. Integer rhoncus quam eu neque volutpat, et pulvinar nibh suscipit. In laoreet odio et sem bibendum rhoncus. Nunc dictum scelerisque gravida. Suspendisse volutpat nibh lectus, sit amet cursus ligula ultrices a. Mauris tempor eget risus sed laoreet. Proin fermentum lobortis sapien, et ultrices turpis vestibulum a. Morbi mollis nec orci at cursus. Nunc euismod neque dui, eu efficitur risus finibus sit amet. Duis felis augue, pretium vel felis a, scelerisque hendrerit nibh. Mauris efficitur consectetur molestie. Donec ac dolor nec odio mollis placerat. Etiam vel sem elementum, luctus nisi ac, volutpat ex. Curabitur auctor bibendum placerat. Aenean maximus ante nulla, eget vehicula tortor sagittis a.

Demo: A hamburger menu used to present navigation commands


HamburgerMenuButton invokes a menu (by default, a Drawer), usually to provide navigation and other UI on a mobile device.


import HamburgerMenuButton from 'elix/src/HamburgerMenuButton.js';
const hamburgerMenuButton = new HamburgerMenuButton(); // or
const hamburgerMenuButton = document.createElement('elix-hamburger-menu-button');


<script type="module" src="node_modules/elix/src/HamburgerMenuButton.js"></script>
  <!-- Drawer contents go here -->
  <button>About Us</button>  


The hamburger menu UI pattern is somewhat controversial. Some strengths:

  • It gives mobile apps a way to compact way to provide the user access to a large number of commands.
  • The pattern downplays commands that may not be frequently used, which can help keep users focused on a primary task.
  • The three line icon is a conventional visual cue to the button's purpose.


  • On its own, the icon may not be sufficient to let some users (particularly older users) understand its purpose.
  • A common placement for a hamburger menu button is in the upper-left corner, but it's awkward for a user to reach up to that location on a mobile device.
  • Burying important commands in a hamburger menu reduces discoverability, increases the time required to complete a task, and increases perceived task difficulty.

Further reading:

See also


Ancestry: HamburgerMenuButton → ReactiveElement → HTMLElement

Built with mixins AttributeMarshallingMixin, FocusVisibleMixin, KeyboardMixin, OpenCloseMixin, ReactiveMixin, RenderUpdatesMixin, and ShadowTemplateMixin.

By default, this uses these elements in the following roles:

$ property

A convenient shortcut for looking up an element by ID in the component's Shadow DOM subtree.

Example: if component's template contains a shadow element <button id="foo">, you can use the reference this.$.foo to obtain the corresponding button in the component instance's shadow tree. The $ function is simply a shorthand for getElementById, so this.$.foo is the same as this.shadowRoot.getElementById('foo').

Type: object

Defined by ShadowTemplateMixin

close(closeResult) method

Close the component (if not already closed).

Some components like AlertDialog want to indicate why or how they were closed. To support such scenarios, you can supply a value to the optional closeResult parameter. This closeResult will be made available in the whenClosed promise and the state.closeResult member.


  • closeResult: objectan indication of how or why the element closed

Defined by OpenCloseMixin

closed event

Raised when the component closes.

Defined by OpenCloseMixin

closed property

True if the element is currently closed.

Type: boolean

Defined by OpenCloseMixin

closeFinished property

True if the element has completely closed.

For components not using asynchronous open/close effects, this property returns the same value as the closed property. For elements that have a true value of state.openCloseEffects (e.g., elements using TransitionEffectMixin), this property returns true only if state.effect is "close" and state.effectPhase is "after".

Type: boolean

Defined by OpenCloseMixin

defaultState property

The default state for the component. This can be extended by mixins and classes to provide additional default state.

Type: State

Defined by ReactiveMixin

fromEdge property

The edge from which the menu will appear, in terms of the menu's container.

The start and end values refer to text direction: in left-to-right languages such as English, these are equivalent to left and right, respectively.

Type: 'end'|'left'|'right'|'start'

Default: 'start'

menuButtonRole property

The class, tag, or template used to create the menu button element.

Type: function|string|HTMLTemplateElement

Default: SeamlessButton

menuRole property

The class, tag, or template used to create the menu (drawer).

Type: function|string|HTMLTemplateElement

Default: Drawer

open() method

Open the element (if not already opened).

Defined by OpenCloseMixin

opened property

True if the element is currently opened.

Type: boolean

Defined by OpenCloseMixin

opened event

Raised when the component opens.

Defined by OpenCloseMixin

opened-changed event

Raised when the opened/closed state of the component changes.

Defined by OpenCloseMixin

render() method

Render the component to the DOM.

This method does nothing if the state has not changed since the last render call.

This method invokes all internal render methods. It then invoked componentDidMount (for first render) or componentDidUpdate (for subsequent renders).

Defined by ReactiveMixin

setState(changes) method

Update the component's state by merging the specified changes on top of the existing state. If the component is connected to the document, and the new state has changed, this returns a promise to asynchronously render the component. Otherwise, this returns a resolved promise.


  • changes: objectthe changes to apply to the element's state

Returns: Promise - resolves when the new state has been rendered

Defined by ReactiveMixin

shouldComponentUpdate(nextState) method

Return true if the component should update.

By default, ReactiveMixin will perform a shallow check of property values like React's PureComponent. This seems adequate for most web components. You can override this to always return true (like React's base Component class), or to perform more specific, deeper checks for changes in state.


  • nextState: Statethe proposed new state for the element

Returns: boolean - true if the component should update (rerender)

Defined by ReactiveMixin

state property

The component's current state. The returned state object is immutable. To update it, invoke setState.

Type: State

Defined by ReactiveMixin

suppressFocusVisibility() method

Temporarily suppress visibility of the keyboard focus until the next keydown event.

This can be useful in components like Menu that actively manage where the focus is in response to mouse hover activity. If the user uses the keyboard to invoke a menu, then changes to using the mouse, it can be distracting to see the focus indicator moving as well. In such situations, the component can invoke this method (e.g., in response to mousemove) to temporarily suppress focus visibility.

Defined by FocusVisibleMixin

symbols.keydown() method

See the symbols documentation for details.

Defined by KeyboardMixin

toggle(opened) method

Toggle the open/close state of the element.


  • opened: booleantrue if the element should be opened, false if closed.

Defined by OpenCloseMixin

updates property

The attributes and properies that should be applied to the component on render. By default, this is an empty plain object. Your mixin or component can extend this to identify the properties to set on the host element or elements in the shadow subtree.

Type: object

Defined by RenderUpdatesMixin

whenClosed() method

This method can be used as an alternative to listening to the "opened-changed" event, particularly in situations where you want to only handle the next time the component is closed.

Returns: Promise A promise that resolves when the element has completely closed, including the completion of any asynchronous opening effect.

Defined by OpenCloseMixin