Guide your users through a tour of your app
Clone or download
Latest commit 03eb569 Oct 22, 2018
Permalink
Failed to load latest commit information.
docs Fix bug of classes not being added to targets on returned-to steps. (#… Oct 17, 2018
src Change `data-id` to `data-shepherd-step-id` on Step content elements. ( Oct 22, 2018
test Change `data-id` to `data-shepherd-step-id` on Step content elements. ( Oct 22, 2018
.browserslistrc Remove maintained node versions Sep 7, 2018
.codeclimate.yml Move bind methods to their own file (#222) Aug 25, 2018
.esdoc.js Implement ESDoc (#226) Aug 29, 2018
.eslintignore Start on cypress (#209) Aug 14, 2018
.eslintrc.js Move bind methods to their own file (#222) Aug 25, 2018
.gitignore add `.vscode` directory to `.gitignore` (#237) Sep 5, 2018
.npmignore npmignore HISTORY.md and CONTRIBUTING.md Oct 13, 2018
.stylelintrc.js Feature/webpack (#212) Aug 15, 2018
.travis.yml Specify two globs for css and js Oct 13, 2018
CHANGELOG.md Update CHANGELOG.md Oct 21, 2018
CONTRIBUTING.md Change localhost port for cypress tests and document how its used (#257) Sep 30, 2018
HISTORY.md Update contributing.md Aug 26, 2018
LICENSE Update LICENSE Jul 9, 2018
README.md update screenshot of intro step in README (#264) Oct 8, 2018
_config.yml Add theme Jul 16, 2018
babel.config.js Do not specify targets Sep 13, 2018
cypress.json Change localhost port for cypress tests and document how its used (#257) Sep 30, 2018
index.md fix docs typo (#272) Oct 12, 2018
install.json Replace direct usage of Popper.js with Tippy.js (#261) Oct 8, 2018
package.json 2.0.0-beta.34 Oct 23, 2018
postcss.config.js [feature/builder] - replace Gulp with module loader and npm (#203) Aug 7, 2018
webpack.config.js Bundle tippy with the main Shepherd distribtion file. (#270) Oct 11, 2018
webpack.test.config.js Add test:unit:watch command Aug 27, 2018
yarn.lock Bump a bunch of deps (#281) Oct 19, 2018

README.md

Shepherd

Ship Shape

Shepherd is maintained by Ship Shape. Contact us for Ember.js consulting, development, and training for your project.

npm version Build Status Maintainability Test Coverage Greenkeeper badge

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 shepherd.js --save

yarn

yarn add shepherd.js

Usage

let tour = new Shepherd.Tour({
  defaultStepOptions: {
    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