This package has been deprecated

Author message:

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

tether-shepherd
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/tether-shepherd package

1.8.1 • Public • Published

Shepherd

GitHubversion

Guide your users through a tour of your app

Install

Dependencies

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.

License

Copyright © 2015 HubSpot - MIT License

Readme

Keywords

none

Package Sidebar

Install

npm i tether-shepherd

Weekly Downloads

8,663

Version

1.8.1

License

MIT

Last publish

Collaborators

  • henryqdineen
  • maxwellskala
  • arota-hubspot
  • service-ccs
  • rberdeen-hubspot
  • also
  • kj800x
  • friss
  • jhilker
  • geoffdaigle
  • timmfin