| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
- <title>metisMenu - index</title>
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap/dist/css/bootstrap.min.css" />
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/font-awesome/css/font-awesome.min.css">
- <link rel="stylesheet" href="https://unpkg.com/metismenu/dist/metisMenu.min.css" />
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs/themes/prism.css" />
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/animate.css" />
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/noty/lib/noty.css">
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/noty/lib/themes/relax.css">
- <link rel="stylesheet" href="assets/css/app.css">
- <script src="https://cdn.jsdelivr.net/npm/jquery"></script>
- <script src="https://cdn.jsdelivr.net/npm/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
- <script src="https://unpkg.com/metismenu"></script>
- <script src="https://cdn.jsdelivr.net/npm/prismjs"></script>
- <script src="https://cdn.jsdelivr.net/npm/noty"></script>
- </head>
- <body>
- <header>
- <div class="navbar navbar-expand-md navbar-dark bg-dark box-shadow">
- <div class="container d-flex justify-content-between">
- <a href="index.html" class="navbar-brand d-flex align-items-center">
- <strong>metisMenu</strong>
- </a>
- <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault"
- aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
- <span class="navbar-toggler-icon"></span>
- </button>
- <div class="collapse navbar-collapse" id="navbarsExampleDefault">
- <ul class="navbar-nav ml-auto">
- <li class="nav-item dropdown">
- <a class="nav-link dropdown-toggle" href="#" id="dropdown01" data-toggle="dropdown" aria-haspopup="true"
- aria-expanded="false">Examples</a>
- <div class="dropdown-menu" aria-labelledby="dropdown01">
- <a class="dropdown-item" href="mm-vertical.html">Vertical Menu</a>
- <a class="dropdown-item" href="mm-horizontal.html">Horizontal Menu</a>
- <a class="dropdown-item" href="mm-folder.html">Folder View</a>
- <a class="dropdown-item" href="mm-vertical-hover.html">Hover Option For Desktop</a>
- <a class="dropdown-item" href="mm-animate.html">Animate</a>
- <a class="dropdown-item" href="mm-event.html">Event</a>
- <a class="dropdown-item" href="mm-event2.html">Event 2</a>
- <a class="dropdown-item" href="mm-dispose.html">Stop & Start metisMenu</a>
- <a class="dropdown-item" href="mm-ajax.html">Ajax</a>
- <a class="dropdown-item" href="mm-faq.html">FAQ</a>
- <a class="dropdown-item" href="mm-bs-card.html">Bootstrap Card</a>
- <a class="dropdown-item" href="mm-docs.html">Docs</a>
- </div>
- </li>
- <li class="nav-item dropdown">
- <a class="nav-link dropdown-toggle" href="#" id="dropdown02" data-toggle="dropdown" aria-haspopup="true"
- aria-expanded="false">Templates</a>
- <div class="dropdown-menu" aria-labelledby="dropdown02">
- <a class="dropdown-item" href="https://onokumus.com/chaldene" target="_blank">Chaldene Admin</a>
- <a class="dropdown-item" href="https://onokumus.com/elektron" target="_blank">Elektron Admin</a>
- <a class="dropdown-item" href="https://onokumus.com/twbuttons/" target="_blank">twbuttons</a>
- </div>
- </li>
- <li class="nav-item">
- <a class="nav-link" href="https://onokumus.com" target="_blank">onokumus</a>
- </li>
- </ul>
- </div>
- </div>
- </div>
- </header>
- <div class="container">
- <script async defer src="https://buttons.github.io/buttons.js"></script>
- <section class="jumbotron text-center">
- <h1 class="jumbotron-heading">metisMenu</h1>
- <p class="lead text-muted">A jQuery menu plugin</p>
- <p>
- <a class="github-button" href="https://github.com/onokumus/metismenu" data-icon="octicon-star" data-size="large"
- data-show-count="true" aria-label="Star onokumus/metismenu on GitHub">Star</a>
- <a class="github-button" href="https://github.com/onokumus/metismenu/fork" data-icon="octicon-repo-forked"
- data-size="large" data-show-count="true" aria-label="Fork onokumus/metismenu on GitHub">Fork</a>
- <a class="github-button" href="https://github.com/onokumus/metismenu/archive/master.zip" data-icon="octicon-cloud-download"
- data-size="large" aria-label="Download onokumus/metismenu on GitHub">Download</a>
- </p>
- <p>
- <a href="https://www.npmjs.com/package/metismenu"><img src="https://img.shields.io/npm/v/metismenu.svg?style=flat"
- alt="NPM version"></a>
- <a href="https://npmjs.org/package/metismenu"><img src="https://img.shields.io/npm/dm/metismenu.svg?style=flat"
- alt="NPM monthly downloads"></a>
- <a href="https://npmjs.org/package/metismenu"><img src="https://img.shields.io/npm/dt/metismenu.svg?style=flat"
- alt="NPM total downloads"></a>
- <a href="https://travis-ci.org/onokumus/metismenu"><img src="https://img.shields.io/travis/onokumus/metismenu.svg?style=flat&label=Travis"
- alt="Linux Build Status"></a>
- <a href="https://www.jsdelivr.com/package/npm/metismenu"><img src="https://data.jsdelivr.com/v1/package/npm/metismenu/badge"
- alt=""></a>
- <a href="https://packagist.org/packages/onokumus/metismenu"><img src="https://img.shields.io/packagist/v/onokumus/metismenu.svg"
- alt="Packagist"></a>
- </p>
- </section>
- <ul>
- <li><a href="#getting-started">Getting started</a>
- <ul>
- <li><a href="#install">Install</a></li>
- <li><a href="#download">Download</a></li>
- </ul>
- </li>
- <li><a href="#usage">Usage</a>
- <ul>
- <li><a href="#stopping-list-opening-on-certain-elements">Stopping list opening on certain elements</a></li>
- </ul>
- </li>
- <li><a href="#options">Options</a>
- <ul>
- <li><a href="#toggle">toggle</a></li>
- <li><a href="#dispose">dispose</a></li>
- <li><a href="#preventdefault">preventDefault</a></li>
- <li><a href="#triggerelement">triggerElement</a></li>
- <li><a href="#parenttrigger">parentTrigger</a></li>
- <li><a href="#submenu">subMenu</a></li>
- </ul>
- </li>
- <li><a href="#events">Events</a></li>
- <li><a href="#migrating-to-v3-from-v2">Migrating to v3 from v2</a></li>
- <li><a href="#demo">Demo</a></li>
- <li><a href="#about">About</a>
- <ul>
- <li><a href="#related-projects">Related projects</a></li>
- <li><a href="#contributors">Contributors</a></li>
- <li><a href="#contributing">Contributing</a></li>
- <li><a href="#release-history">Release History</a></li>
- <li><a href="#author">Author</a></li>
- <li><a href="#license">License</a></li>
- </ul>
- </li>
- </ul>
- <p><em>(TOC generated by <a href="https://github.com/verbose/verb">verb</a> using <a href="https://github.com/jonschlinkert/markdown-toc">markdown-toc</a>)</em></p>
- <h2 id="getting-started">Getting started</h2>
- <h3 id="install">Install</h3>
- <p>Install with <a href="https://www.npmjs.com/">npm</a>:</p>
- <pre><code class="lang-sh">$ npm <span class="hljs-keyword">install</span> <span class="hljs-comment">--save metismenu</span>
- </code></pre>
- <p>Install with <a href="https://yarnpkg.com">yarn</a>:</p>
- <pre><code class="lang-sh">$ yarn <span class="hljs-keyword">add</span><span class="bash"> metismenu</span>
- </code></pre>
- <p>Install with <a href="https://getcomposer.org/">composer</a></p>
- <pre><code class="lang-sh">$ composer <span class="hljs-keyword">require</span> onokumus/<span class="hljs-symbol">metismenu:</span>dev-master
- </code></pre>
- <h3 id="download">Download</h3>
- <p><a href="https://github.com/onokumus/metisMenu/archive/master.zip">download</a></p>
- <h2 id="usage">Usage</h2>
- <ol>
- <li>
- <p>Include metismenu StyleSheet</p>
- <pre><code class="lang-html"><span class="hljs-tag"><<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"https://unpkg.com/metismenu/dist/metisMenu.min.css"</span>></span>
- <span class="hljs-comment"><!-- OR --></span>
- <span class="hljs-tag"><<span class="hljs-name">link</span> <span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/metismenu/dist/metisMenu.min.css"</span>></span>
- </code></pre>
- </li>
- <li>
- <p>Include jQuery</p>
- <pre><code class="lang-html"><span class="hljs-tag"><<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://unpkg.com/jquery"</span>></span><span class="undefined"></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span>
- <span class="hljs-comment"><!-- OR --></span>
- <span class="hljs-tag"><<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/jquery"</span>></span><span class="undefined"></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span>
- </code></pre>
- </li>
- <li>
- <p>Include metisMenu plugin's code</p>
- <pre><code class="lang-html"><span class="hljs-tag"><<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://unpkg.com/metismenu"</span>></span><span class="undefined"></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span>
- <span class="hljs-comment"><!-- OR --></span>
- <span class="hljs-tag"><<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/metismenu"</span>></span><span class="undefined"></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span>
- </code></pre>
- </li>
- <li>
- <p>Add id attribute to unordered list</p>
- <pre><code class="lang-html"><span class="hljs-tag"><<span class="hljs-name">ul</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"metismenu"</span>></span>
-
- <span class="hljs-tag"></<span class="hljs-name">ul</span>></span>
- </code></pre>
- </li>
- <li>
- <p>Make expand/collapse controls accessible</p>
- <blockquote>
- <p>Be sure to add <code>aria-expanded</code> to the element <code>a</code>. This attribute explicitly defines
- the current state of the collapsible element to screen readers and similar assistive technologies. If the
- collapsible element is closed by default, it should have a value of <code>aria-expanded="false"</code>.
- If you've set the collapsible element's parent <code>li</code> element to be open by default using
- the <code>mm-active</code> class, set <code>aria-expanded="true"</code> on the control instead.
- The plugin will automatically toggle this attribute based on whether or not the collapsible element has
- been opened or closed.</p>
- </blockquote>
- <pre><code class="lang-html"><span class="hljs-tag"><<span class="hljs-name">ul</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"metismenu"</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">li</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"mm-active"</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">a</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span> <span class="hljs-attr">aria-expanded</span>=<span class="hljs-string">"true"</span>></span>Menu 1<span class="hljs-tag"></<span class="hljs-name">a</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">ul</span>></span>
- ...
- <span class="hljs-tag"></<span class="hljs-name">ul</span>></span>
- <span class="hljs-tag"></<span class="hljs-name">li</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">li</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">a</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span> <span class="hljs-attr">aria-expanded</span>=<span class="hljs-string">"false"</span>></span>Menu 2<span class="hljs-tag"></<span class="hljs-name">a</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">ul</span>></span>
- ...
- <span class="hljs-tag"></<span class="hljs-name">ul</span>></span>
- <span class="hljs-tag"></<span class="hljs-name">li</span>></span>
- ...
- <span class="hljs-tag"></<span class="hljs-name">ul</span>></span>
- </code></pre>
- </li>
- <li>
- <p>Arrow Options</p>
- <blockquote>
- <p>add <code>has-arrow</code> class to <code>a</code> element</p>
- </blockquote>
- <pre><code class="lang-html"><span class="hljs-tag"><<span class="hljs-name">ul</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"metismenu"</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">li</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"mm-active"</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">a</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"has-arrow"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span> <span class="hljs-attr">aria-expanded</span>=<span class="hljs-string">"true"</span>></span>Menu 1<span class="hljs-tag"></<span class="hljs-name">a</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">ul</span>></span>
- ...
- <span class="hljs-tag"></<span class="hljs-name">ul</span>></span>
- <span class="hljs-tag"></<span class="hljs-name">li</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">li</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">a</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"has-arrow"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span> <span class="hljs-attr">aria-expanded</span>=<span class="hljs-string">"false"</span>></span>Menu 2<span class="hljs-tag"></<span class="hljs-name">a</span>></span>
- <span class="hljs-tag"><<span class="hljs-name">ul</span>></span>
- ...
- <span class="hljs-tag"></<span class="hljs-name">ul</span>></span>
- <span class="hljs-tag"></<span class="hljs-name">li</span>></span>
- ...
- <span class="hljs-tag"></<span class="hljs-name">ul</span>></span>
- </code></pre>
- </li>
- <li>
- <p>Call the plugin:</p>
- <pre><code class="lang-javascript"> <span class="hljs-variable">$(</span><span class="hljs-string">"#metismenu"</span>).metisMenu();
- </code></pre>
- </li>
- </ol>
- <h3 id="stopping-list-opening-on-certain-elements">Stopping list opening on certain elements</h3>
- <p>Setting aria-disabled="true" in the <code><a></code> element as shown will stop metisMenu
- opening the menu for that particular list. This can be changed dynamically and will be obeyed correctly:</p>
- <pre><code class="lang-html"><span class="hljs-tag"><<span class="hljs-name">a</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span> <span class="hljs-attr">aria-expanded</span>=<span class="hljs-string">"false"</span> <span class="hljs-attr">aria-disabled</span>=<span class="hljs-string">"true"</span>></span>List 1<span class="hljs-tag"></<span class="hljs-name">a</span>></span>
- </code></pre>
- <h2 id="options">Options</h2>
- <h4 id="toggle">toggle</h4>
- <p>Type: <code>Boolean</code>
- Default: <code>true</code></p>
- <p>For auto collapse support.</p>
- <pre><code class="lang-javascript"> <span class="hljs-variable">$(</span><span class="hljs-string">"#metismenu"</span>).metisMenu({
- <span class="hljs-symbol">toggle:</span> <span class="hljs-keyword">false</span>
- });
- </code></pre>
- <h4 id="dispose">dispose</h4>
- <p>Type: <code>String</code>
- Default: <code>null</code></p>
- <p>For stop and destroy metisMenu.</p>
- <pre><code class="lang-javascript"> <span class="hljs-variable">$(</span><span class="hljs-string">"#metismenu"</span>).metisMenu(<span class="hljs-string">'dispose'</span>);
- </code></pre>
- <h4 id="preventdefault">preventDefault</h4>
- <p>Type: <code>Boolean</code>
- Default: <code>true</code></p>
- <blockquote>
- <p>Prevents or allows dropdowns' onclick events after expanding/collapsing.</p>
- </blockquote>
- <pre><code class="lang-javascript"> <span class="hljs-variable">$(</span><span class="hljs-string">"#menu"</span>).metisMenu({
- <span class="hljs-symbol">preventDefault:</span> <span class="hljs-keyword">false</span>
- });
- </code></pre>
- <p><em>since from version 2.7.0</em></p>
- <h4 id="triggerelement">triggerElement</h4>
- <p>Type: <code>jQuery selector</code>
- Default: <code>a</code></p>
- <pre><code class="lang-javascript"> <span class="hljs-symbol">$</span>(<span class="hljs-string">"#metismenu"</span>).metisMenu({
- triggerElement: <span class="hljs-string">'.nav-link'</span> <span class="hljs-comment">// bootstrap 4</span>
- });
- </code></pre>
- <h4 id="parenttrigger">parentTrigger</h4>
- <p>Type: <code>jQuery selector</code>
- Default: <code>li</code></p>
- <pre><code class="lang-javascript"> <span class="hljs-symbol">$</span>(<span class="hljs-string">"#metismenu"</span>).metisMenu({
- parentTrigger: <span class="hljs-string">'.nav-item'</span> <span class="hljs-comment">// bootstrap 4</span>
- });
- </code></pre>
- <h4 id="submenu">subMenu</h4>
- <p>Type: <code>jQuery selector</code>
- Default: <code>ul</code></p>
- <pre><code class="lang-javascript"> <span class="hljs-symbol">$</span>(<span class="hljs-string">"#metismenu"</span>).metisMenu({
- subMenu: <span class="hljs-string">'.nav.flex-column'</span> <span class="hljs-comment">// bootstrap 4</span>
- });
- </code></pre>
- <h2 id="events">Events</h2>
- <table>
- <thead>
- <tr>
- <th><strong>Event Type</strong></th>
- <th><strong>Description</strong></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>show.metisMenu</td>
- <td>This event fires immediately when the <code>_show</code> instance method is called.</td>
- </tr>
- <tr>
- <td>shown.metisMenu</td>
- <td>This event is fired when a collapse <code>ul</code> element has been made visible to the user (will wait
- for CSS transitions to complete).</td>
- </tr>
- <tr>
- <td>hide.metisMenu</td>
- <td>This event is fired immediately when the <code>_hide</code> method has been called.</td>
- </tr>
- <tr>
- <td>hidden.metisMenu</td>
- <td>This event is fired when a collapse <code>ul</code> element has been hidden from the user (will wait for
- CSS transitions to complete).</td>
- </tr>
- </tbody>
- </table>
- <h2 id="migrating-to-v3-from-v2">Migrating to v3 from v2</h2>
- <ul>
- <li>Update <code>metisMenu.js</code> & <code>metisMenu.css</code> files</li>
- <li>Change <code>active</code> class to <code>mm-active</code></li>
- </ul>
- <h3>Author</h3>
- <p><strong>Osman Nuri Okumus</strong></p>
- <ul>
- <li><a href="https://github.com/onokumus">github/onokumus</a></li>
- <li><a href="https://twitter.com/onokumus">twitter/onokumus</a></li>
- </ul>
- <h3>License</h3>
- <p>Copyright © 2018, <a href="https://github.com/onokumus">Osman Nuri Okumus</a>.<br>
- Released under the <a href="LICENSE">MIT License</a>.</p>
- <script>
- $(function () {
- $('table').addClass('table table-bordered table-striped');
- });
- </script>
- </div>
- </body>
- </html>
|