Skip to content
Guide your users through a tour of your app
Branch: master
Clone or download
rwwagner90 Greenkeeper/rollup plugin visualizer 2.1.1 (#404)
* chore(package): update rollup-plugin-visualizer to version 2.1.1

Closes #397

* chore(package): update lockfile yarn.lock
Latest commit eeb523e Jun 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add stale config Jan 13, 2019
docs Add scrollIntoView options and polyfill (#402) Jun 12, 2019
src Add TypeScript definitions (#360) Jun 13, 2019
test Fix modal padding test failures, add tests, docs (#390) Jun 4, 2019
.browserslistrc Add back IE support (#380) May 25, 2019
.codeclimate.yml setAttributeNS -> setAttribute, add modal utils tests (#312) Jan 13, 2019
.esdoc.js Use index.md for ESDoc May 9, 2019
.eslintignore Use rollup instead of webpack (#309) Jan 12, 2019
.eslintrc.js Move bind methods to their own file (#222) Aug 25, 2018
.gitignore Move esdoc to root folder May 2, 2019
.npmignore npmignore HISTORY.md and CONTRIBUTING.md Oct 13, 2018
.stylelintrc.js Feature/webpack (#212) Aug 15, 2018
.travis.yml Move esdoc to root folder May 2, 2019
CHANGELOG.md Update CHANGELOG.md Jun 13, 2019
CONTRIBUTING.md Remove webpack from contributing.md Jan 13, 2019
HISTORY.md Update Changelog Jun 9, 2019
LICENSE Update LICENSE Jul 9, 2018
README.md Update rollup, add size badge Jun 13, 2019
_config.yml Add theme Jul 16, 2018
babel.config.js Ensure arguments are passed down to trigger (#381) May 26, 2019
cypress.json Use rollup instead of webpack (#309) Jan 12, 2019
index.md Use index.md for ESDoc May 9, 2019
install.json Replace direct usage of Popper.js with Tippy.js (#261) Oct 8, 2018
jest.config.js Bump deps, tweak jest config Feb 12, 2019
package.json Greenkeeper/rollup plugin visualizer 2.1.1 (#404) Jun 14, 2019
rollup.config.js Split up lodash packages May 2, 2019
yarn.lock Greenkeeper/rollup plugin visualizer 2.1.1 (#404) Jun 14, 2019

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 npm bundle size 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

You can’t perform that action at this time.