Priority Nav Scroller
Priority Nav Scroller is a plugin for the priority+ navigation pattern. When navigation items don’t fit on screen they are hidden and can be scrolled into view or using controls.
View demo
Installation
$ npm install priority-nav-scroller --save-dev
Usage
Import JS
The script is an ES6(ES2015) module but the compiled version is included in the build as "src/scripts/priority-nav-scroller-umd.js". You can also copy "src/scripts/priority-nav-scroller.js" into your own site if your build process can accommodate ES6 modules.
; // Init with default setupconst priorityNavScrollerDefault = ; // Init with all options at default settingconst priorityNavScrollerDefault = ; // Init multiple nav scrollers with the same optionslet navScrollers = document; navScrollers;
Options
Property | Default | Type | Description |
---|---|---|---|
selector |
'.nav-scroller' | String/Node | Container element selector. |
navSelector |
'.nav-scroller-nav' | String | Item element selector. |
contentSelector |
'.nav-scroller-content' | String | Content element selector. |
itemSelector |
'.nav-scroller-item' | String | Item element selector. |
buttonLeftSelector |
'.nav-scroller-btn--left' | String | Left button element selector. |
buttonRightSelector |
'.nav-scroller-btn--right' | String | Right button element selector. |
scrollStep |
80 | Number/String | Amount to scroll on button click. 'average' gets the average link width. |
Import SASS
;
Markup
Item 1 Item 2 Item 3 ... ... ...
Using other tags
The demos use a <div> for "nav-scroller-content" and <a> tags for the "nav-scroller-item" but you can also use a <ul> as below.
Item 1 ...
The buttons use an svg for the arrow icon but this can be replaced with an image, text or html entities(< >, ← →, ◄ ►), just update the nav-scroller-button styles as needed.
Compatibility
Browser support
Supports all modern browsers(Firefox, Chrome and Edge) released as of January 2018. For older browsers you may need to include polyfills for Nodelist.forEach and Element.classList.
Demo site
Clone or download from Github.
$ npm install$ gulp serve
Credits
A horizontal scrolling navigation pattern for touch and mouse with moving current indicator by Ben Frain.
A Priority+ Navigation With Scrolling and Dropdowns by Micah Miller-Eshleman on CSS-Tricks.
The Priority+ Navigation Pattern by Chris Coyier on CSS-Tricks.
License
MIT © Nigel O Toole