scrolllock.js: Navigation Scroll-lock

The navigation bar becomes fix to the top of the screen after scrolling down the page.

How to include the script

The stylesheet is best included in the header of the document.

<link rel="stylesheet" href="css/scrolllock.css"/>

This include can be added to the header or placed inline before the script is invoked.

<script src="lib/positions.js"></script>
<script src="js/scrolllock.js"></script>

Or use Require.js.

requirejs([
	'lib/positions.js',
	'js/scrolllock.js'
], function(positions, Scrolllock) {
	...
});

Or import into an MVC framework.

var positions = require('lib/positions.js');
var Scrolllock = require('js/scrolllock.js');

How to start the script

var scrollock = new Scrolllock({
	'element' : document.getElementById('id'),
	'threshold' : {x:0, y:96}
});

id : {string} - The ID attribute of an element somewhere in the document.

threshold : {object} - After scrolling this far, the navigation becomes fixed. If not defined, the position will be measured instead.

How to build the script

This project uses node.js from http://nodejs.org/

This project uses gulp.js from http://gulpjs.com/

The following commands are available for development:

• npm install - Installs the prerequisites.
• gulp import - Re-imports libraries from supporting projects to ./src/libs/ if available under the same folder tree.
• gulp dev - Builds the project for development purposes.
• gulp dist - Builds the project for deployment purposes.
• gulp watch - Continuously recompiles updated files during development sessions.
• gulp serve - Serves the project on a temporary web server at http://localhost:8500/.
• gulp php - Serves the project on a temporary php server at http://localhost:8500/.

License

This work is licensed under a MIT License. The latest version of this and other scripts by the same author can be found on Github and at WoollyMittens.nl.