Package detail

tether-shepherd

also24.4kMITdeprecated1.8.1

tether-shepherd has been renamed to shepherd.js. see https://github.com/shipshapecode/shepherd

Guide your users through a tour of your app.

readme

Shepherd

Install

Dependencies

Tether

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

npm

$ npm install tether-shepherd

bower

$ bower install tether-shepherd

Eager

The easiest way to add a Shepherd tour to your site is with Eager. Click Install to create a tour right on your site with no coding required.

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.