Skip to content

bespokejs/bespoke-hash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

0c85ae6 · Jan 16, 2018

History

43 Commits
Mar 29, 2017
Oct 3, 2017
Mar 29, 2017
Oct 3, 2017
Jun 15, 2014
Jun 15, 2014
Jun 15, 2014
Jan 16, 2018
Jun 15, 2014
Jun 15, 2014
Mar 29, 2017
Mar 29, 2017
Oct 3, 2017
Oct 3, 2017
Jan 16, 2018

Repository files navigation

Build Status Coverage Status

bespoke-hash

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

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

When using browser globals:

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

Starting from #1, all routes are numbered by default.

Named Routes

If you'd like to use named hash routes instead, add data-bespoke-hash attributes to your slide markup.

<article>
  <section data-bespoke-hash="catchy-title"></section>
  <section data-bespoke-hash="shameless-plug"></section>
  <section data-bespoke-hash="controversial-statement"></section>
  <section data-bespoke-hash="explanation-of-controversial-statement"></section>
  <section data-bespoke-hash="shameless-self-promotion"></section>
</article>

Alternatively, you can specify the value using id attributes in your slide markup.

<article>
  <section id="catchy-title"></section>
  <section id="shameless-plug"></section>
  <section id="controversial-statement"></section>
  <section id="explanation-of-controversial-statement"></section>
  <section id="shameless-self-promotion"></section>
</article>

If both the data-bespoke-hash and id attributes are used, data-bespoke-hash wins. When looking for a match, the plugin consults the data-bespoke-hash attribute on a slide first, then the id attribute.

Package managers

npm

$ npm install bespoke-hash

Bower

$ bower install bespoke-hash

Credits

This plugin was built with generator-bespokeplugin.

License

MIT License