249

GitHub - shipshapecode/shepherd: Guide your users through a tour of your app

 5 years ago
source link: https://github.com/shipshapecode/shepherd
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

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 Download count all time npm Build Status Maintainability Test Coverage Greenkeeper badge

Guide your users through a tour of your app

Install

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

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


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK