Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 1.69 KB

README.md

File metadata and controls

67 lines (43 loc) · 1.69 KB

Build Status Coverage Status

bespoke-keys

Keyboard Support for Bespoke.js

Download

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

Usage

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

For example, when using CommonJS modules:

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

bespoke.from('article', [
  keys()
]);

When using browser globals:

bespoke.from('article', [
  bespoke.plugins.keys()
]);

By default, bespoke-keys uses the spacebar/shift+spacebar, left/right and page up/down keys to navigate the slides.

If your presentation is laid out vertically, you can allow navigation with up/down instead of left/right with the vertical option:

bespoke.from('article', [
  keys('vertical')
]);

Package managers

npm

$ npm install bespoke-keys

Bower

$ bower install bespoke-keys

Credits

This plugin was built with generator-bespokeplugin.

License

MIT License