Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an example tour using TourGuide JS #575

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

llewelld
Copy link
Collaborator

Adds an example tour using TourGuide JS, to test out its capabilities. The content and coding is just for testing: in no way final!

For TourGuide JS, see:
https://tourguidejs.com/

For comparison with #564.

Initially I thought otherwise, but having tried it it's now clear that TourGuide can also be used without having to make any significant changes to the original HTML (it just needs appropriate ids added so the elements can be refered to).

Styling aside the main difference I notice with Shepherd.js is that TourGuide prevents interaction with anything on the page. In contrast, Shepherd.js allows the user to interact with the highlighted element.

Not allowing the user to interact with anything makes it easier to create the tour (no need to worry about users messing with things mid-tour), but arguably isn't as nice for the user.

Shepherd.js makes it easier to dynamically change the labels on the buttons, but I'm not sure that's going to be too important.

Unfortunately, like Shepherd.js, TourGuide also has trouble with a phone-sized display, so we'll have to figure out a solution to that in either case (e.g. disabling the tour on small-screen devices as you suggested earlier @gedankenstuecke).

Contributes to #535.

Adds an example tour using TourGuide JS, to test out its capabilities.
The content and coding is just for testing: in no way final!

For TourGuide JS, see:
https://tourguidejs.com/

Contributes to alan-turing-institute#535.
@github-actions
Copy link

Coverage report

The coverage rate went from 98.9% to 98.9% ⬇️

None of the new lines are part of the tested code. Therefore, there is no coverage data about them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant