Hopscotch is a framework to make it easy for developers to add product tours to their pages. Hopscotch accepts a tour JSON object as input and provides an API for the developer to control rendering the tour display and managing the tour progress.
To learn more about Hopscotch and the API, check out linkedin.github.io/hopscotch.
/archivescontains .zip and .tar.gz files of prior and current distributions of Hopscotch.
/demohas a simple demo page with a Hopscotch tour. Much of the content duplicates what's on the github.io page.
/distincludes compiled files for the current version of Hopscotch. This folder gets zipped up into an archive when a new release is published.
/testis our testing suite for the core framework, written using Jasmine.
How do I get started with Hopscotch?
The Hopscotch files included in
Check out linkedin.github.io/hopscotch for usage examples and a live sample tour. If you'd like to tweak some of the default assets included with Hopscotch to best suit your project's needs, read on for details about how to modify and rebuild a custom version of Hopscotch.
How do I build Hopscotch?
Hopscotch is built using Grunt.js. Learn more about how to get started with Grunt. Running
grunt will build Hopscotch (publishing artifacts to
/tmp) and run the test suite against the newly built artifacts.
How do I test Hopscotch?
Testing is done as part of the build process using the Jasmine testing framework. You can run
grunt test to verify changes.
Continuous integration is run against every pull request using Travis CI. Please verify your changes against the test suite before submitting a pull request! We also recommend adding new tests for any new features or bugfixes as feasible.
How do I tweak Hopscotch to meet my project's requirements?
Depending on your use case, you might want to modify and/or rebuild some of the basic components included with Hopscotch. Some moddable options include...
- CSS tweaks: The Hopscotch stylesheet is written in and compiled using LESS. If you make changes to your local copy of these stylesheets, they'll be recompiled when building Hopscotch.
- Bubble markup: The internal markup for Hopscotch bubbles are rendered using templates. See the README.md file in
/src/tlfor details. Any templates in
- Callbacks & Page Interactivity: See linkedin.github.io/hopscotch for details about the Hopscotch API and what tour/callout events you can register events with. Use callbacks to integrate Hopscotch with other libraries and/or presentational elements you might have on your page.
I want to contribute! How can I help?
See CONTRIBUTING.md for details on how to contribute back to the public Hopscotch repository on GitHub.