![Guide your users through a tour of your app](/demo/assets/img/demo.png)
![]() IE / Edge |
![]() Firefox |
![]() Chrome |
![]() Safari |
---|---|---|---|
Edge | last 2 versions | last 2 versions | last 2 versions |
Shepherd v6.x no longer ships with the required polyfills to work with IE 11 out of the box,
however, if you are supporting IE 11 already, you are probably shipping some polyfills.
The only required polyfills are Object.assign
, Symbol
, and element.matches
for things to work.
Our demo app includes the polyfills using Polyfill.io, but Babel, core-js, etc would all work.
<script src="https://polyfill.io/v3/polyfill.min.js?features=Object.assign%2CSymbol%2CElement.prototype.matches"></script>
You will also need a Web Components polyfill, which we include with:
<script src="https://cdn.jsdelivr.net/npm/@webcomponents/[email protected]/webcomponents-bundle.js"></script>
We encourage contributions of all kinds. If you would like to contribute in some way, please review our guidelines for contributing.
Here we showcase some of the awesome libraries built using Shepherd.
Ember addon for the site tour library Shepherd
An Angular wrapper for the site tour library Shepherd
A React wrapper for the site tour library Shepherd
A Vue wrapper for the site tour library Shepherd
Rails engine that generates and tracks Shepherd tours within an application
SimplePlanner uses Shepherd to help new users get familiar with its collaborative scheduling approach. You do need to sign up via OAuth or email to see the scheduling tour. Check out the Envato Tuts+ Startup Series on its codebase which describes how Simple Planner was built.
Brokermate uses Shepherd to guide users through initial setup steps.
If you have a cool open-source library built on Shepherd, PR this doc.