johnpittman / breadcrumbmanager-js

Built as a way to track the previous history of anything and navigate back and forth through it in JavaScript.

breadcrumbmanager

Built as a way to track the previous history of anything and navigate back and forth through it in JavaScript.

Notes

Universal module defined to be used with requirejs, node, commonjs, or global scoped if no module loader is used.

• All files in the dist folder are minified for production use.
• All files in the src directory are the source code for development use.
• Packages point at the dist minified code with source maps.

Development

Requirements

• nodejs
• npm install
• npm install -g gulp

Test

gulp test

Gulp Commands

Each process is dependent upon the previous. If one fails the build process exits.

• gulp
• gulp test (Unit specifications)
• gulp build (Test, folder clean-ups, minification, source maps, renaming)
• gulp deploy (Test, build, versioning)

Usage

Installation

npm: npm install breadcrumbmanager
bower: bower install breadcrumbmanager

How to use...

var bcm = new BreadcrumbManager(5);

bcm.add('1');
bcm.add('2');
bcm.add('3');
bcm.add('4');
console.log('Breadcrumbs list: ' + bcm._breadcrumbs);

var breadcrumb = bcm.prev();
breadcrumb = bcm.prev();
console.log('Navigate back twice. Breadcrumb: ' + breadcrumb);

bcm.add('5');
console.log('Visit a new path and add: 5');
console.log('Breadcrumbs list: ' + bcm._breadcrumbs);

breadcrumb = bcm.prev();
console.log('Navigate back once. Breadcrumb: ' + breadcrumb);

breadcrumb = bcm.next();
console.log('Navigate forward once. Breadcrumb: ' + breadcrumb);
breadcrumb = bcm.next();
console.log('Navigate forward once. Breadcrumb: ' + breadcrumb);

var contains = bcm.contains('1');
console.log('Check history for 1. Breadcrumb found: ' + contains);

console.log('Add 8 breadcrumbs to breach the set limit of 5.');
bcm.add('6');
bcm.add('7');
bcm.add('8');
bcm.add('9');
bcm.add('10');
bcm.add('11');
bcm.add('12');
bcm.add('13');
console.log('Breadcrumbs list: ' + bcm._breadcrumbs);

console.log('Clear breadcrumbs.');
bcm.clear();

Release Notes

v1.1.0

Breaking Changings...

• Changed the name of the breadcrumbmanager.js to BreadcrumbManager.js. Captial file names for classes just make more sense to me so I can distiguish bundles and frameworks from single classes.

Additional...

• Change the "main" property in package.json to point to the src/EventHandler.js since node is what uses it and needs the source code for debugging. If using things like Browserify it won't matter since the minification process happens after all files are compiled into one. This is better for everyone.

v1.0.4

• Optimized the add method. Don't use slice.

v1.0.2

• Going over the limit now contains the correct amount of breadcrumbs. Previously came up one short after adding a new breadcrumb at the limit.

v1.0.0

• Fully tested and stable.