The mobile first menu navigation for today's modern web, developed with native JavaScript and packed with lots of features.
Download the package and check the demo folder, or check it online here.
- Mobile First Design
- ES6+ sources and powerful build tools
- SCSS sources with powerful mixins and advanced inheritance and automation functionality
- very light footprint,
3kbin size when minified - 3 sets of positions top (main), left or right
- provides a set of options for JavaScript initialization
- DATA API allows you to automatically initiate without JS invocation
- modern browsers supported and semi-modern alike with a special polyfill for IE10+ provided
-
On mobile
- uses the default events behavior, it requires some elements to click on
- shows the
<button class="navbar-toggle">element for element visibility toggle - menu items have a
<i class="parent-toggle">element that enables visibility of the submenus - makes use of the
open-mobileclass to toggle submenus via theclickhandler
-
On the desktop
- hides mobile specific elements and changes event behavior to mouse hover
- opens submenus on
mouseenter, by addingopenandopen-positionclasses to the menu item, in rapid succession - hides submenus on
mouseleave, by removing the above classes in a delayed succesion
You can install this through NPM:
$ npm install navbar.js
Download the latest package. unpack and inspect the contents. You need to copy the navbar.js and navbar.css or their minified variations to your app assets folders as follows.
Link the required CSS in your document <head> tag
<link href="../assets/css/navbar.css" rel="stylesheet">Link the required JS in your document <body> tag, though it should work in the <head> as well
<script src="../assets/js/navbar.js"></script>Initiate the function for your elements at the end of your <body> tag
<script>
var myMenu = new Navbar('selector');
</script>To use the DATA-API, you need to provide the data-function="navbar" attribute to your navbar, like so:
<nav class="navbar" data-function="navbar">
<a href="#" title="App Name">Brand Name</a>
<button class="navbar-toggle">
<i class="menu-icon"></i>
</button>
<div>
<ul class="nav">
<li><a href="#">Link Title</a></li>
<li><a href="#">Another Link Title</a></li>
</ul>
</div>
</nav>
Alternatively you can use only the menu itself and use the specific attribute:
<div class="sidebar">
<ul class="nav" data-function="navbar">
<li><a href="#">Link Title</a></li>
<li><a href="#">Another Link Title</a></li>
</ul>
</div>
Other initialization and markup options apply, explained in the demo.
import Navbar from 'navbar.js'
let myNav = new Navbar('#myNav')// get and store it
var Navbar = require("navbar.js");
// initialize it
var myMenu = new Navbar('#myNav');You have 3 build tools for building custom builds
$ npm run build- to compile and minify the ES6/ES7 source navbar.js and navbar.min.js$ npm run compile- to compile and minify the navbar.less and other demo related sources$ npm run bundle- to execute both the above in paralel$ npm run polyfill- to build the polyfill
You can create your own custom styling, here's a quickie:
- create a new file for instance
src/scss/my-navbar.scss, - include the mixins and variables' values you need (check out the demos for more)
- run the below script
node compile.js INPUTFILE:src/scss/my-navbar.scss OUTPUTFILE:path-to/src/css/my-navbar.min.css MIN:true