Contrib.social

Provide a JS interface by exposing Shepherd Tour object

Open on Drupal.org →
Created on 1 July 2024, 6 months ago
Updated 24 July 2024, 5 months ago

Problem/Motivation

As a site integrator, i want (amongst others):
- Start a tour via js
- inspect a tour
- set tour to a specific tip
- ...

None of which is currently possible.

Steps to reproduce

Proposed resolution

Options are:
1) Expose API of the underlying Shepherd library
2) Abstract our own API

Proposing 1) because
- Shepherd is a solid library
- It seems to have a solid freemium business model
- Promising to stay for some time
- There is no competitor in sight
- We've done the same with e.g. CKEditor
- It's way simpler to implement and promises far less bikeshedding and architectural work

Remaining tasks

Do it.

User interface changes

None.

API changes

Expose Shepherd API.

Data model changes

None.

Release note snippet

The Tour module now allows to access the Shepherd.js tour object via this: ...

See Shepherd API: https://docs.shepherdpro.com/guides/usage/

📌 Task
Status

Fixed

Version

2.0

Component

Code

Created by

🇩🇪Germany geek-merlin Freiburg, Germany

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024