JSPM

shepherd.js

2.0.0-beta.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 129047
  • Score
    100M100P100Q152761F
  • License MIT

Guide your users through a tour of your app.

Package Exports

  • shepherd.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (shepherd.js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Shepherd

GitHub version

Guide your users through a tour of your app

Install

Dependencies

Installing via npm will bring in the above dependencies as well.

npm

$ npm install tether-shepherd

Usage

let tour = new Shepherd.Tour({
  defaults: {
    classes: 'shepherd-theme-arrows'
  }
});

tour.addStep('example', {
  title: 'Example Shepherd',
  text: 'Creating a Shepherd is easy too! Just create ...',
  attachTo: '.hero-example bottom',
  advanceOn: '.docs-link click'
});

tour.start();

API documentation

Demo

Contributing

We encourage contributions of all kinds. If you would like to contribute in some way, please review our guidelines for contributing.

License

MIT License