JSPM

shepherd.js

2.8.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 129047
  • Score
    100M100P100Q152855F
  • 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

Ship Shape

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

npm version Download count all time npm Build Status Maintainability Test Coverage Greenkeeper badge

Guide your users through a tour of your app

Installation

JS Framework Wrappers

We strive to make it easy to use Shepherd in all the major frameworks, and have written wrappers to facilitate this.

Install Directly

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: 'shadow-md bg-purple-dark',
    scrollTo: true
  }
});

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();

Documentation

API documentation

Demo

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