next-sidebar
Version:
Lightweight Sidebar Admin menu for Bootstrap Application, compatible with BS4 & BS5
260 lines (237 loc) • 18.8 kB
HTML
---
layout: default
title: Blank
---
<div class="container mt-5">
<p align="center">
<a href="#"> <img src="https://raw.githubusercontent.com/Nelh/Next-sidebar/HEAD/assets/images/next-full.png"> </a>
</p>
<h1 align="center">
Next Sidebar
</h1>
<p align="center">
Minimalistic but perfect Sidebar Menu for your Admin Application (Built with bootstrap)
<p>
<p align="center">
<a href="https://img.shields.io/npm/dt/next-sidebar"> <img src="https://img.shields.io/npm/dt/next-sidebar"
alt="downoad"></a> <a href="https://github.com/Nelh/Next-sidebar/blob/main/LICENSE"> <img
src="https://img.shields.io/badge/license-MIT-green.svg" alt="License"></a><br /> <a
href="https://badge.fury.io/js/next-sidebar"> <img src="https://badge.fury.io/js/next-sidebar.svg"
alt="npm"></a><br />
</p>
<p align="center">
<a href="https://nodei.co/npm/next-sidebar/"><img
src="https://nodei.co/npm/next-sidebar.png?downloads=true&downloadRank=true&stars=true"></a>
</p>
<div class="row">
<div class="col-md-8 offset-md-2 col-12">
<div class="mb-4">
<h2 id="install">Install</h2>
<p>You can manually download Next-sidebar <a
href="https://cdn.jsdelivr.net/npm/next-sidebar@1/assets/css/next-sidebar.css">css here</a> and <a
href="https://cdn.jsdelivr.net/npm/next-sidebar@1/assets/js/next-sidebar.js">js here</a></p>
</div>
<div class="mb-4">
<h4 id="cdn-jsdelivr">CDN jsDelivr</h4>
<p> When you only need to include Next-sidebar compiled CSS or JS, you can use <a
href="https://www.jsdelivr.com/">jsDelivr</a>.
</p>
</div>
<div>
<pre class='code code-html scrollable'><code class="scrollable"><span class="co"><!-- CSS only --></span>
<span class="kw"><link</span><span class="ot"> rel=</span><span class="st">"stylesheet"</span><span class="ot"> href=</span><span class="st">"https://cdn.jsdelivr.net/npm/next-sidebar@1/assets/css/next-sidebar.min.css"</span><span class="kw">></span></code></pre>
</div>
<pre class="code code-html html scrollable"><code class="scrollable"><span class="co"><!-- JavaScript --></span>
<span class="kw"><script</span><span class="ot"> src=</span><span class="st">"https://cdn.jsdelivr.net/npm/next-sidebar@1/assets/js/next-sidebar.min.js"</span><span class="kw">></script></span></code></pre>
<div>
<h4 id="download-via-npm">Download via npm</h4>
<p>You can install and use next-sidebar with npm. It's registered as <a
href="https://www.npmjs.com/package/next-sidebar">next-sidebar</a>.</p>
<pre class="code code-javascript"><code class="scrollable">$ npm install next-sidebar</code></pre>
<h4 id="from-sources">From sources</h4>
<p>If you want to use the development version of the plugin, build from source manually.</p>
<pre class="code code-javascript"><code class="scrollable">$ git clone https://github.com/Nelh/Next-sidebar.git
$ cd next-sidebar
$ npm install
$ npm run dev</code></pre>
</div>
<h2 id="before-using-next-sidebar">Before using Next-sidebar</h2>
<p>the following requirement should meet.</p>
<ul>
<li>Ensure you have bootstrap 4 or higher installed</li>
<li>Ensure you have jquery 3x installed</li>
<li>Ensure you have an icons library installed for this example we use font awesome 5</li>
</ul>
<h2 id="how-to-use">How to use</h2>
<pre class="code code-html"><code class="scrollable"><span class="kw"><body</span><span class="ot"> class=</span><span class="st">"app is-collapsed"</span><span class="kw">></span>
<span class="co"><!-- Sidebar content here --></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"container-wide"</span><span class="kw">></span>
<span class="co"><!-- Page content here --></span>
<span class="kw"></div></span>
<span class="kw"></body></span></code></pre>
<p>
if you want to have the sidebar minify by default remove the class <code class="scrollable">.is-collapsed</code> from the body tag
</p>
<pre class="code code-html"><code class="scrollable"><span class="kw"><div</span><span class="ot"> class=</span><span class="st">"sidebar"</span><span class="kw">></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"sidebar-inner"</span><span class="kw">></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"sidebar-logo"</span><span class="kw">></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"d-flex align-items-center flex-nowrap"</span><span class="kw">></span>
<span class="kw"><a</span><span class="ot"> class=</span><span class="st">"sidebar-link text-decoration-none"</span><span class="ot"> href=</span><span class="st">"#"</span><span class="kw">></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"d-flex align-items-center flex-nowrap"</span><span class="kw">></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"logo-sm"</span><span class="kw">></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"logo d-flex align-items-center justify-content-center"</span><span class="kw">></span>
<span class="co"><!-- The Minify logo here --></span>
<span class="kw"></div></span>
<span class="kw"></div></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"logo-text d-flex align-items-center justify-content-center"</span><span class="kw">></span>
<span class="co"><!-- The Full Logo here --></span>
<span class="kw"></div></span>
<span class="kw"></div></span>
<span class="kw"></a></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">""</span><span class="kw">></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"mobile-toggle sidebar-toggle"</span><span class="kw">></span>
<span class="kw"><a</span><span class="ot"> href=</span><span class="st">"#"</span><span class="ot"> class=</span><span class="st">"text-decoration-none"</span><span class="kw">></span>
<span class="co"><!-- closing sidebar icon here --></span>
<span class="kw"></a></span>
<span class="kw"></div></span>
<span class="kw"></div></span>
<span class="kw"></div></span>
<span class="kw"></div></span>
<span class="kw"><ul</span><span class="ot"> class=</span><span class="st">"sidebar-menu scrollable position-relative"</span><span class="kw">></span>
<span class="kw"><li</span><span class="ot"> class=</span><span class="st">"nav-item dropdown"</span><span class="kw">></span>
<span class="kw"><a</span><span class="ot"> class=</span><span class="st">"nav-link"</span><span class="ot"> href=</span><span class="st">"#"</span><span class="kw">></span>
<span class="co"><!-- Navigation icon here --></span>
<span class="kw"><span</span><span class="ot"> class=</span><span class="st">"icon-holder"</span><span class="kw">></span>
<span class="kw"><i</span><span class="ot"> class=</span><span class="st">"fal fa-home"</span><span class="kw">></i></span>
<span class="kw"></span></span>
<span class="co"><!-- Navigation link here --></span>
<span class="kw"><span</span><span class="ot"> class=</span><span class="st">"title"</span><span class="kw">></span>Dashboard<span class="kw"></span></span>
<span class="kw"></a></span>
<span class="kw"></li></span>
<span class="kw"><li</span><span class="ot"> class=</span><span class="st">"nav-item dropdown"</span><span class="kw">></span>
<span class="kw"><a</span><span class="ot"> class=</span><span class="st">"nav-link dropdown-toggle"</span><span class="ot"> href=</span><span class="st">"#"</span><span class="kw">></span>
<span class="kw"><span</span><span class="ot"> class=</span><span class="st">"icon-holder"</span><span class="kw">></span>
<span class="kw"><i</span><span class="ot"> class=</span><span class="st">"fas fa-fingerprint"</span><span class="kw">></i></span>
<span class="kw"></span></span>
<span class="kw"><span</span><span class="ot"> class=</span><span class="st">"title"</span><span class="kw">></span>Auth<span class="kw"></span></span>
<span class="co"><!-- Icon for dropdown here --></span>
<span class="kw"><span</span><span class="ot"> class=</span><span class="st">"arrow"</span><span class="kw">></span>
<span class="kw"><i</span><span class="ot"> class=</span><span class="st">"fas fa-angle-right"</span><span class="kw">></i></span>
<span class="kw"></span></span>
<span class="kw"></a></span>
<span class="kw"><ul</span><span class="ot"> class=</span><span class="st">"dropdown-menu"</span><span class="kw">></span>
<span class="kw"><li></span>
<span class="kw"><a</span><span class="ot"> class=</span><span class="st">"sidebar-link"</span><span class="ot"> href=</span><span class="st">"#"</span><span class="kw">></span>404<span class="kw"></a></span>
<span class="kw"></li></span>
<span class="kw"></ul></span>
<span class="kw"></li></span>
<span class="kw"></ul></span>
<span class="kw"></div></span>
<span class="kw"></div></span></code></pre>
<p>
For dropdown and sub dropdown, you can use it as this
</p>
<pre class="code code-html"><code class="scrollable"><span class="kw"><li</span><span class="ot"> class=</span><span class="st">"nav-item dropdown"</span><span class="kw">></span>
<span class="kw"><a</span><span class="ot"> class=</span><span class="st">"nav-link dropdown-toggle"</span><span class="ot"> href=</span><span class="st">"#"</span><span class="kw">></span>
<span class="co"><!-- First level --></span>
<span class="kw"></a></span>
<span class="kw"><ul</span><span class="ot"> class=</span><span class="st">"dropdown-menu"</span><span class="kw">></span>
<span class="kw"><li</span><span class="ot"> class=</span><span class="st">"nav-item dropdown"</span><span class="kw">></span>
<span class="kw"><a</span><span class="ot"> class=</span><span class="st">"nav-link dropdown-toggle"</span><span class="ot"> href=</span><span class="st">"#"</span><span class="kw">></span>
<span class="co"><!-- Second level --></span>
<span class="kw"></a></span>
<span class="kw"></li></span>
<span class="kw"><li</span><span class="ot"> class=</span><span class="st">"nav-item dropdown"</span><span class="kw">></span>
<span class="kw"><a</span><span class="ot"> class=</span><span class="st">"nav-link dropdown-toggle"</span><span class="ot"> href=</span><span class="st">"#"</span><span class="kw">></span>
<span class="co"><!-- Third level --></span>
<span class="kw"></a></span>
<span class="kw"><ul</span><span class="ot"> class=</span><span class="st">"dropdown-menu"</span><span class="kw">></span>
<span class="kw"><li></span>
<span class="kw"><a</span><span class="ot"> href=</span><span class="st">"#"</span><span class="kw">></span>
<span class="co"><!-- etc --></span>
<span class="kw"></a></span>
<span class="kw"></li></span>
<span class="kw"></ul></span>
<span class="kw"></li></span>
<span class="kw"></ul></span>
<span class="kw"></li></span></code></pre>
<p>
Add the button that will trigger the collapsing of the navigation menu in the page content
</p>
<pre class="code code-html html"><code class="scrollable"><span class="kw"><a</span><span class="ot"> id=</span><span class="st">"sidebar-toggle"</span><span class="ot"> class=</span><span class="st">"sidebar-toggle nav-link"</span><span class="ot"> href=</span><span class="st">"#"</span><span class="kw">></span>
<span class="kw"><i</span><span class="ot"> class=</span><span class="st">"fal fa-bars"</span><span class="kw">></i></span>
<span class="kw"></a></span></code></pre>
<h2 id="requirement">Requirement</h2>
<p>
Those are few dependencies you might need to run this library
</p>
<table class="table">
<thead>
<tr class="header">
<th align="left">Library</th>
<th align="left">version</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">Bootstrap 4, 5+ (required)</td>
<td align="left">4x,5x</td>
<td align="left">Use as an extension of the bootstrap library</td>
</tr>
<tr class="even">
<td align="left">Jquery (required)</td>
<td align="left">3x</td>
<td align="left">Only use to trigger click event, can be alter and remove at your conveniance</td>
</tr>
<tr class="odd">
<td align="left">Font awesome (optional)</td>
<td align="left">5x</td>
<td align="left">can be replace with any others icons library</td>
</tr>
<tr class="even">
<td align="left">Perfect Scrollbar (optional)</td>
<td align="left">1x</td>
<td align="left">-</td>
</tr>
</tbody>
</table>
<p>__</p>
<h2 id="browser-support">Browser Support</h2>
<table class="table">
<thead>
<tr class="header">
<th align="left"><img src="https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png"
alt="Chrome" /></th>
<th align="left"><img src="https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png"
alt="Firefox" /></th>
<th align="left"><img src="https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png"
alt="Safari" /></th>
<th align="left"><img src="https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png"
alt="Opera" /></th>
<th align="left"><img src="https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png"
alt="Edge" /></th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">Latest ✔</td>
<td align="left">Latest ✔</td>
<td align="left">Latest ✔</td>
<td align="left">Latest ✔</td>
<td align="left">Latest ✔</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="donating">Donating</h2>
<p>If you want to support the development of this extension, you can buy me a coffee</p>
<p><a href="https://paypal.me/lembongui"><img src="https://www.paypalobjects.com/en_AU/i/btn/btn_donateCC_LG.gif"
alt="paypal" /></a> Thank you!</p>
<hr />
<h2 id="contributing">Contributing</h2>
<p>If you have any idea, feel free to open an issue to discuss a new feature or fork and submit your changes back to
me.</p>
</div>
</div>
</div>