/bespoke-advanced

Auto advance slides on a timer in bespoke.js

Primary LanguageJavaScriptOtherNOASSERTION

Build Status Coverage Status

Check out the presentation/demo.

Auto advance slides on a timer in bespoke.js, started and stopped with the A key.

⚠️ This project has been archived

No future updates are planned. Feel free to continue using it, but expect no support.

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'),
  advanced = require('bespoke-advanced');

bespoke.from('#presentation', [
  advanced()
]);

When using browser globals:

bespoke.from('#presentation', [
  bespoke.plugins.advanced()
]);
  • Key A: start and stop auto advancing.

Options

These are the defaults, which you can override. For example, when using CommonJS modules:

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

bespoke.from('#presentation', [
  advanced({
      interval: 3000, // Time between advances in milliseconds
      key: 0x41 // (65) "A" key.
    })
]);

When using browser globals:

bespoke.from('#presentation', [
  bespoke.plugins.advanced({
      interval: 3000, // Time between advances in milliseconds
      key: 0x41 // (65) "A" key.
    })
]);

Package managers

npm

$ npm install bespoke-advanced

Bower

$ bower install bespoke-advanced

Credits

Mark Dalgleish for bespoke.js and related tools. This plugin was built with generator-bespokeplugin.

Ed Schipul, eschipul on flickr, for his photo river boat in the mist (CC BY-SA 2.0). My recompressed version is also released under CC BY-SA 2.0.

My best friend, bespoke-convenient, for continued support - through good and bad times. You mah bro, bro.

License

Copyright (c) 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, Joel Purra All rights reserved.

When using bespoke-advanced, comply to the MIT license. Please see the LICENSE file for details, and the MIT License on Wikipedia.