Modern Navigation Component
MIT License
The mobile first menu navigation for today's modern web, sourced with Typescript and packed with lots of features.
Download the package and check the docs folder, or check it online here.
5kb
in size when minifiedOn mobile
<button class="navbar-toggle">
element for element visibility toggle<button class="subnav-toggle">
element that enables visibility of the submenusopen-mobile
class to toggle submenus via the click
handler
On the desktop
mouseenter
, by adding open
and open-position
classes to the menu item, in rapid succession
mouseleave
, by removing the above classes in a delayed succesion
On both mobile and desktop, Navbar.js allows for full keyboard navigation via the TAB and SPACE keys. In addition, directional arrows provide navigation on desktop with RTL support.
You can install this through NPM:
$ npm install @thednp/navbar
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</a></li>
</ul>
</div>
Other initialization and markup options apply, explained in the demo.
import Navbar from '@thednp/navbar'
const myNav = new Navbar('#myNav')