alphabet-jump-nav
v1.0.0
Published
A mobile friendly alphabetical side navigation to quickly jump between sections of a list.
Downloads
235
Readme
Alphabet Jump Nav
A mobile friendly alphabetical side navigation to quickly jump between sections of a list. Similar to the iOS section index navigation.
Install
npm install alphabet-jump-nav
Using
<div class="my-view">
<ul id="my-list">
<li data-title="A Title">A Title</li>
<li data-title="B Title">B Title</li>
<li data-title="C Title">C Title</li>
<li data-title="D Title">D Title</li>
<!-- ..... -->
<li data-title="Z Title">Z Title</li>
</ul>
</div>
let JumpNav = require('alphabet-jump-nav')
let myView = document.querySelector('#my-view')
let myList = document.querySelector('#my-list')
let jumpNav = new JumpNav()
jumpNav.appendTo(myView)
jumpNav.linkTo(myList)
Dont forget to import the CSS
@import "node_modules/alphabet-jump-nav/style.less"
Changelog
v1.0.0
- Initial release
License
MIT © Kevin Jantzer – Blackstone Publishing