metisMenu

A jQuery menu plugin

Installation

• npm

npm install metismenu

• Bower

bower install metisMenu

• composer

composer require onokumus/metismenu:dev-master

• Download

Usage

1. Include metisMenu StyleSheet

   <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/metisMenu/2.0.2/metisMenu.min.css">

2. Include jQuery

   <script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>

3. Include metisMenu plugin's code

   <script src="//cdnjs.cloudflare.com/ajax/libs/metisMenu/2.0.2/metisMenu.min.js"></script>

4. Add class metismenu to unordered list

   <ul class="metismenu" id="menu">
   
   </ul>

5. Call the plugin:

   $("#menu").metisMenu();

Options

toggle

Type: Boolean Default: true

For auto collapse support.

  $("#menu").metisMenu({
    toggle: false
  });

activeClass

Type: String Default: active

  $("#menu").metisMenu({
    activeClass: 'active'
  });

collapseClass

Type: String Default: collapse

  $("#menu").metisMenu({
    collapseClass: 'collapse'
  });

collapseInClass

Type: String Default: in

  $("#menu").metisMenu({
    collapseInClass: 'in'
  });

collapsingClass

Type: String Default: collapsing

  $("#menu").metisMenu({
    collapsingClass: 'collapsing'
  });

doubleTapToGo

Type: Boolean Default: false

For double tap support.

  $("#menu").metisMenu({
    doubleTapToGo: true
  });

Testing

npm install
grunt serve

DEMO

Contains a simple HTML file to demonstrate metisMenu plugin.

Release History

DATE VERSION CHANGES

• 2015-07-25 v2.0.3 When the active item has doubleTapToGo should not collapse
• 2015-05-23 v2.0.2 fixed
• 2015-05-22 v2.0.1 changeable classname support
• 2015-04-03 v2.0.0 Remove Bootstrap dependency
• 2015-03-24 v1.1.3 composer support
• 2014-11-01 v1.1.3 Bootstrap 3.3.0
• 2014-07-07 v1.1.0 Add double tap functionality
• 2014-06-24 v1.0.3 cdnjs support & rename plugin
• 2014-06-18 v1.0.3 Create grunt task
• 2014-06-10 v1.0.2 Fixed for IE8 & IE9

Author

metisMenu was made with love by these guys and a bunch of awesome contributors.

| --- | --- | --- | --- | --- | --- | --- Osman Nuri Okumuş |

License

MIT License