index.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  6. <title>metisMenu - index</title>
  7. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap/dist/css/bootstrap.min.css" />
  8. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/font-awesome/css/font-awesome.min.css">
  9. <link rel="stylesheet" href="https://unpkg.com/metismenu/dist/metisMenu.min.css" />
  10. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs/themes/prism.css" />
  11. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/animate.css" />
  12. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/noty/lib/noty.css">
  13. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/noty/lib/themes/relax.css">
  14. <link rel="stylesheet" href="assets/css/app.css">
  15. <script src="https://cdn.jsdelivr.net/npm/jquery"></script>
  16. <script src="https://cdn.jsdelivr.net/npm/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
  17. <script src="https://unpkg.com/metismenu"></script>
  18. <script src="https://cdn.jsdelivr.net/npm/prismjs"></script>
  19. <script src="https://cdn.jsdelivr.net/npm/noty"></script>
  20. </head>
  21. <body>
  22. <header>
  23. <div class="navbar navbar-expand-md navbar-dark bg-dark box-shadow">
  24. <div class="container d-flex justify-content-between">
  25. <a href="index.html" class="navbar-brand d-flex align-items-center">
  26. <strong>metisMenu</strong>
  27. </a>
  28. <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault"
  29. aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
  30. <span class="navbar-toggler-icon"></span>
  31. </button>
  32. <div class="collapse navbar-collapse" id="navbarsExampleDefault">
  33. <ul class="navbar-nav ml-auto">
  34. <li class="nav-item dropdown">
  35. <a class="nav-link dropdown-toggle" href="#" id="dropdown01" data-toggle="dropdown" aria-haspopup="true"
  36. aria-expanded="false">Examples</a>
  37. <div class="dropdown-menu" aria-labelledby="dropdown01">
  38. <a class="dropdown-item" href="mm-vertical.html">Vertical Menu</a>
  39. <a class="dropdown-item" href="mm-horizontal.html">Horizontal Menu</a>
  40. <a class="dropdown-item" href="mm-folder.html">Folder View</a>
  41. <a class="dropdown-item" href="mm-vertical-hover.html">Hover Option For Desktop</a>
  42. <a class="dropdown-item" href="mm-animate.html">Animate</a>
  43. <a class="dropdown-item" href="mm-event.html">Event</a>
  44. <a class="dropdown-item" href="mm-event2.html">Event 2</a>
  45. <a class="dropdown-item" href="mm-dispose.html">Stop &amp; Start metisMenu</a>
  46. <a class="dropdown-item" href="mm-ajax.html">Ajax</a>
  47. <a class="dropdown-item" href="mm-faq.html">FAQ</a>
  48. <a class="dropdown-item" href="mm-bs-card.html">Bootstrap Card</a>
  49. <a class="dropdown-item" href="mm-docs.html">Docs</a>
  50. </div>
  51. </li>
  52. <li class="nav-item dropdown">
  53. <a class="nav-link dropdown-toggle" href="#" id="dropdown02" data-toggle="dropdown" aria-haspopup="true"
  54. aria-expanded="false">Templates</a>
  55. <div class="dropdown-menu" aria-labelledby="dropdown02">
  56. <a class="dropdown-item" href="https://onokumus.com/chaldene" target="_blank">Chaldene Admin</a>
  57. <a class="dropdown-item" href="https://onokumus.com/elektron" target="_blank">Elektron Admin</a>
  58. <a class="dropdown-item" href="https://onokumus.com/twbuttons/" target="_blank">twbuttons</a>
  59. </div>
  60. </li>
  61. <li class="nav-item">
  62. <a class="nav-link" href="https://onokumus.com" target="_blank">onokumus</a>
  63. </li>
  64. </ul>
  65. </div>
  66. </div>
  67. </div>
  68. </header>
  69. <div class="container">
  70. <script async defer src="https://buttons.github.io/buttons.js"></script>
  71. <section class="jumbotron text-center">
  72. <h1 class="jumbotron-heading">metisMenu</h1>
  73. <p class="lead text-muted">A jQuery menu plugin</p>
  74. <p>
  75. <a class="github-button" href="https://github.com/onokumus/metismenu" data-icon="octicon-star" data-size="large"
  76. data-show-count="true" aria-label="Star onokumus/metismenu on GitHub">Star</a>
  77. <a class="github-button" href="https://github.com/onokumus/metismenu/fork" data-icon="octicon-repo-forked"
  78. data-size="large" data-show-count="true" aria-label="Fork onokumus/metismenu on GitHub">Fork</a>
  79. <a class="github-button" href="https://github.com/onokumus/metismenu/archive/master.zip" data-icon="octicon-cloud-download"
  80. data-size="large" aria-label="Download onokumus/metismenu on GitHub">Download</a>
  81. </p>
  82. <p>
  83. <a href="https://www.npmjs.com/package/metismenu"><img src="https://img.shields.io/npm/v/metismenu.svg?style=flat"
  84. alt="NPM version"></a>
  85. <a href="https://npmjs.org/package/metismenu"><img src="https://img.shields.io/npm/dm/metismenu.svg?style=flat"
  86. alt="NPM monthly downloads"></a>
  87. <a href="https://npmjs.org/package/metismenu"><img src="https://img.shields.io/npm/dt/metismenu.svg?style=flat"
  88. alt="NPM total downloads"></a>
  89. <a href="https://travis-ci.org/onokumus/metismenu"><img src="https://img.shields.io/travis/onokumus/metismenu.svg?style=flat&amp;label=Travis"
  90. alt="Linux Build Status"></a>
  91. <a href="https://www.jsdelivr.com/package/npm/metismenu"><img src="https://data.jsdelivr.com/v1/package/npm/metismenu/badge"
  92. alt=""></a>
  93. <a href="https://packagist.org/packages/onokumus/metismenu"><img src="https://img.shields.io/packagist/v/onokumus/metismenu.svg"
  94. alt="Packagist"></a>
  95. </p>
  96. </section>
  97. <ul>
  98. <li><a href="#getting-started">Getting started</a>
  99. <ul>
  100. <li><a href="#install">Install</a></li>
  101. <li><a href="#download">Download</a></li>
  102. </ul>
  103. </li>
  104. <li><a href="#usage">Usage</a>
  105. <ul>
  106. <li><a href="#stopping-list-opening-on-certain-elements">Stopping list opening on certain elements</a></li>
  107. </ul>
  108. </li>
  109. <li><a href="#options">Options</a>
  110. <ul>
  111. <li><a href="#toggle">toggle</a></li>
  112. <li><a href="#dispose">dispose</a></li>
  113. <li><a href="#preventdefault">preventDefault</a></li>
  114. <li><a href="#triggerelement">triggerElement</a></li>
  115. <li><a href="#parenttrigger">parentTrigger</a></li>
  116. <li><a href="#submenu">subMenu</a></li>
  117. </ul>
  118. </li>
  119. <li><a href="#events">Events</a></li>
  120. <li><a href="#migrating-to-v3-from-v2">Migrating to v3 from v2</a></li>
  121. <li><a href="#demo">Demo</a></li>
  122. <li><a href="#about">About</a>
  123. <ul>
  124. <li><a href="#related-projects">Related projects</a></li>
  125. <li><a href="#contributors">Contributors</a></li>
  126. <li><a href="#contributing">Contributing</a></li>
  127. <li><a href="#release-history">Release History</a></li>
  128. <li><a href="#author">Author</a></li>
  129. <li><a href="#license">License</a></li>
  130. </ul>
  131. </li>
  132. </ul>
  133. <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>
  134. <h2 id="getting-started">Getting started</h2>
  135. <h3 id="install">Install</h3>
  136. <p>Install with <a href="https://www.npmjs.com/">npm</a>:</p>
  137. <pre><code class="lang-sh">$ npm <span class="hljs-keyword">install</span> <span class="hljs-comment">--save metismenu</span>
  138. </code></pre>
  139. <p>Install with <a href="https://yarnpkg.com">yarn</a>:</p>
  140. <pre><code class="lang-sh">$ yarn <span class="hljs-keyword">add</span><span class="bash"> metismenu</span>
  141. </code></pre>
  142. <p>Install with <a href="https://getcomposer.org/">composer</a></p>
  143. <pre><code class="lang-sh">$ composer <span class="hljs-keyword">require</span> onokumus/<span class="hljs-symbol">metismenu:</span>dev-master
  144. </code></pre>
  145. <h3 id="download">Download</h3>
  146. <p><a href="https://github.com/onokumus/metisMenu/archive/master.zip">download</a></p>
  147. <h2 id="usage">Usage</h2>
  148. <ol>
  149. <li>
  150. <p>Include metismenu StyleSheet</p>
  151. <pre><code class="lang-html"><span class="hljs-tag">&lt;<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>&gt;</span>
  152. <span class="hljs-comment">&lt;!-- OR --&gt;</span>
  153. <span class="hljs-tag">&lt;<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>&gt;</span>
  154. </code></pre>
  155. </li>
  156. <li>
  157. <p>Include jQuery</p>
  158. <pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://unpkg.com/jquery"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
  159. <span class="hljs-comment">&lt;!-- OR --&gt;</span>
  160. <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/jquery"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
  161. </code></pre>
  162. </li>
  163. <li>
  164. <p>Include metisMenu plugin&#39;s code</p>
  165. <pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://unpkg.com/metismenu"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
  166. <span class="hljs-comment">&lt;!-- OR --&gt;</span>
  167. <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/metismenu"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
  168. </code></pre>
  169. </li>
  170. <li>
  171. <p>Add id attribute to unordered list</p>
  172. <pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">ul</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"metismenu"</span>&gt;</span>
  173. <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
  174. </code></pre>
  175. </li>
  176. <li>
  177. <p>Make expand/collapse controls accessible</p>
  178. <blockquote>
  179. <p>Be sure to add <code>aria-expanded</code> to the element <code>a</code>. This attribute explicitly defines
  180. the current state of the collapsible element to screen readers and similar assistive technologies. If the
  181. collapsible element is closed by default, it should have a value of <code>aria-expanded=&quot;false&quot;</code>.
  182. If you&#39;ve set the collapsible element&#39;s parent <code>li</code> element to be open by default using
  183. the <code>mm-active</code> class, set <code>aria-expanded=&quot;true&quot;</code> on the control instead.
  184. The plugin will automatically toggle this attribute based on whether or not the collapsible element has
  185. been opened or closed.</p>
  186. </blockquote>
  187. <pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">ul</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"metismenu"</span>&gt;</span>
  188. <span class="hljs-tag">&lt;<span class="hljs-name">li</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"mm-active"</span>&gt;</span>
  189. <span class="hljs-tag">&lt;<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>&gt;</span>Menu 1<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
  190. <span class="hljs-tag">&lt;<span class="hljs-name">ul</span>&gt;</span>
  191. ...
  192. <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
  193. <span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
  194. <span class="hljs-tag">&lt;<span class="hljs-name">li</span>&gt;</span>
  195. <span class="hljs-tag">&lt;<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>&gt;</span>Menu 2<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
  196. <span class="hljs-tag">&lt;<span class="hljs-name">ul</span>&gt;</span>
  197. ...
  198. <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
  199. <span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
  200. ...
  201. <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
  202. </code></pre>
  203. </li>
  204. <li>
  205. <p>Arrow Options</p>
  206. <blockquote>
  207. <p>add <code>has-arrow</code> class to <code>a</code> element</p>
  208. </blockquote>
  209. <pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">ul</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"metismenu"</span>&gt;</span>
  210. <span class="hljs-tag">&lt;<span class="hljs-name">li</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"mm-active"</span>&gt;</span>
  211. <span class="hljs-tag">&lt;<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>&gt;</span>Menu 1<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
  212. <span class="hljs-tag">&lt;<span class="hljs-name">ul</span>&gt;</span>
  213. ...
  214. <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
  215. <span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
  216. <span class="hljs-tag">&lt;<span class="hljs-name">li</span>&gt;</span>
  217. <span class="hljs-tag">&lt;<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>&gt;</span>Menu 2<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
  218. <span class="hljs-tag">&lt;<span class="hljs-name">ul</span>&gt;</span>
  219. ...
  220. <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
  221. <span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
  222. ...
  223. <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
  224. </code></pre>
  225. </li>
  226. <li>
  227. <p>Call the plugin:</p>
  228. <pre><code class="lang-javascript"> <span class="hljs-variable">$(</span><span class="hljs-string">"#metismenu"</span>).metisMenu();
  229. </code></pre>
  230. </li>
  231. </ol>
  232. <h3 id="stopping-list-opening-on-certain-elements">Stopping list opening on certain elements</h3>
  233. <p>Setting aria-disabled=&quot;true&quot; in the <code>&lt;a&gt;</code> element as shown will stop metisMenu
  234. opening the menu for that particular list. This can be changed dynamically and will be obeyed correctly:</p>
  235. <pre><code class="lang-html"><span class="hljs-tag">&lt;<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>&gt;</span>List 1<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
  236. </code></pre>
  237. <h2 id="options">Options</h2>
  238. <h4 id="toggle">toggle</h4>
  239. <p>Type: <code>Boolean</code>
  240. Default: <code>true</code></p>
  241. <p>For auto collapse support.</p>
  242. <pre><code class="lang-javascript"> <span class="hljs-variable">$(</span><span class="hljs-string">"#metismenu"</span>).metisMenu({
  243. <span class="hljs-symbol">toggle:</span> <span class="hljs-keyword">false</span>
  244. });
  245. </code></pre>
  246. <h4 id="dispose">dispose</h4>
  247. <p>Type: <code>String</code>
  248. Default: <code>null</code></p>
  249. <p>For stop and destroy metisMenu.</p>
  250. <pre><code class="lang-javascript"> <span class="hljs-variable">$(</span><span class="hljs-string">"#metismenu"</span>).metisMenu(<span class="hljs-string">'dispose'</span>);
  251. </code></pre>
  252. <h4 id="preventdefault">preventDefault</h4>
  253. <p>Type: <code>Boolean</code>
  254. Default: <code>true</code></p>
  255. <blockquote>
  256. <p>Prevents or allows dropdowns&#39; onclick events after expanding/collapsing.</p>
  257. </blockquote>
  258. <pre><code class="lang-javascript"> <span class="hljs-variable">$(</span><span class="hljs-string">"#menu"</span>).metisMenu({
  259. <span class="hljs-symbol">preventDefault:</span> <span class="hljs-keyword">false</span>
  260. });
  261. </code></pre>
  262. <p><em>since from version 2.7.0</em></p>
  263. <h4 id="triggerelement">triggerElement</h4>
  264. <p>Type: <code>jQuery selector</code>
  265. Default: <code>a</code></p>
  266. <pre><code class="lang-javascript"> <span class="hljs-symbol">$</span>(<span class="hljs-string">"#metismenu"</span>).metisMenu({
  267. triggerElement: <span class="hljs-string">'.nav-link'</span> <span class="hljs-comment">// bootstrap 4</span>
  268. });
  269. </code></pre>
  270. <h4 id="parenttrigger">parentTrigger</h4>
  271. <p>Type: <code>jQuery selector</code>
  272. Default: <code>li</code></p>
  273. <pre><code class="lang-javascript"> <span class="hljs-symbol">$</span>(<span class="hljs-string">"#metismenu"</span>).metisMenu({
  274. parentTrigger: <span class="hljs-string">'.nav-item'</span> <span class="hljs-comment">// bootstrap 4</span>
  275. });
  276. </code></pre>
  277. <h4 id="submenu">subMenu</h4>
  278. <p>Type: <code>jQuery selector</code>
  279. Default: <code>ul</code></p>
  280. <pre><code class="lang-javascript"> <span class="hljs-symbol">$</span>(<span class="hljs-string">"#metismenu"</span>).metisMenu({
  281. subMenu: <span class="hljs-string">'.nav.flex-column'</span> <span class="hljs-comment">// bootstrap 4</span>
  282. });
  283. </code></pre>
  284. <h2 id="events">Events</h2>
  285. <table>
  286. <thead>
  287. <tr>
  288. <th><strong>Event Type</strong></th>
  289. <th><strong>Description</strong></th>
  290. </tr>
  291. </thead>
  292. <tbody>
  293. <tr>
  294. <td>show.metisMenu</td>
  295. <td>This event fires immediately when the <code>_show</code> instance method is called.</td>
  296. </tr>
  297. <tr>
  298. <td>shown.metisMenu</td>
  299. <td>This event is fired when a collapse <code>ul</code> element has been made visible to the user (will wait
  300. for CSS transitions to complete).</td>
  301. </tr>
  302. <tr>
  303. <td>hide.metisMenu</td>
  304. <td>This event is fired immediately when the <code>_hide</code> method has been called.</td>
  305. </tr>
  306. <tr>
  307. <td>hidden.metisMenu</td>
  308. <td>This event is fired when a collapse <code>ul</code> element has been hidden from the user (will wait for
  309. CSS transitions to complete).</td>
  310. </tr>
  311. </tbody>
  312. </table>
  313. <h2 id="migrating-to-v3-from-v2">Migrating to v3 from v2</h2>
  314. <ul>
  315. <li>Update <code>metisMenu.js</code> &amp; <code>metisMenu.css</code> files</li>
  316. <li>Change <code>active</code> class to <code>mm-active</code></li>
  317. </ul>
  318. <h3>Author</h3>
  319. <p><strong>Osman Nuri Okumus</strong></p>
  320. <ul>
  321. <li><a href="https://github.com/onokumus">github/onokumus</a></li>
  322. <li><a href="https://twitter.com/onokumus">twitter/onokumus</a></li>
  323. </ul>
  324. <h3>License</h3>
  325. <p>Copyright © 2018, <a href="https://github.com/onokumus">Osman Nuri Okumus</a>.<br>
  326. Released under the <a href="LICENSE">MIT License</a>.</p>
  327. <script>
  328. $(function () {
  329. $('table').addClass('table table-bordered table-striped');
  330. });
  331. </script>
  332. </div>
  333. </body>
  334. </html>