Introduction

Mmenu (short for mobile menu) is a JavaScript plugin for creating app look-alike off-canvas menus. It turns a basic HTML menu structure (with <nav>, <ul>, <li> and <a> or <span> elements) into a fully functional off-canvas menu with sliding submenus. The mmenu.js plugin knows its way around a bit more complex HTML structures as well, so you probably don't need to change any markup if your migrating from another script or plugin.

Getting started

These documentation pages assume you have some knowledge of HTML, CSS and JavaScript. If you are totally new to frontend development, it might not be the best idea to jump right into a framework as your first step - grasp the basics then come back!

The easiest way to learn how to use the mmenu.js plugin is probably by playing around in the playground. It'll show you how to use some of the available options, extensions and add-ons.

If you're ready for the next step, grab a copy of the mmenu.js plugin from the download page and try the off-canvas tutorial.

Supported browsers

As of version 8, the mmenu.js plugin by default only supports ECMAScript 6 compliant browsers. For Internet Explorer 10 and 11, you'll need the JavaScript polyfills included in the package.

Version 7 should work in Internet Explorer 10 and 11 without any shortcomings, it should also work to some degree in Internet Explorer 9, but you'll need a matchMedia polyfill.

Learn more

Core Options Configuration API CSS & SCSS Extensions Add-ons