bespoke-nav

A composite plugin that combines the navigation plugins for Bespoke.js (bespoke-nav-kbd and bespoke-nav-touch) into a single plugin.

Example

View the demo online.

This repository includes a demo folder that shows this plugin in action. To view it locally, you first need to clone this repository:

$ git clone https://github.com/opendevise/bespoke-nav && cd bespoke-nav

Next, install the dependencies inside the project folder using npm:

$ npm install

Finally, visit the file demo/index.html in your browser to see the plugin in action.

Download

Download the production mode version or the development mode version, or use a package manager.

npm

$ npm install bespoke-nav

Bower

$ bower install bespoke-nav

Usage

This plugin is shipped in a UMD format, meaning it is available as a CommonJS/AMD module or as a browser global.

For example, when using CommonJS modules:

var bespoke = require('bespoke'),
  nav = require('bespoke-nav');

bespoke.from('.deck', [
  nav()
]);

When using a browser global:

bespoke.from('.deck', [
  bespoke.plugins.nav()
]);

Options

You can pass options to the bespoke-nav-kbd and bespoke-nav-touch plugins using the kbd and touch option keys, respectively.

bespoke.from('.deck', [
  nav({ kbd: {...}, touch: {...} })
]);

License

MIT License