Problem/Motivation

The module already is so friendly to expose the following triggers on the document:

model
// Allow other scripts to respond to tour events.
.on('change:isActive', (tourModel, isActive) => {
  $(document).trigger(
    isActive ? 'drupalTourStarted' : 'drupalTourStopped',
  );
});

(tour.js)

But this is only for the tour start and end.

It might be helpful to also trigger on each tour step or add an example in the README how to get the Shepherd events for that.

An example case would be to execute a callback when the next step is made.

Does anyone know how to solve that correctly and with a good DX?

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Comments

anybody created an issue. See original summary.

anybody’s picture

anybody
Primary language German
Location Porta Westfalica
commented
Issue summary: View changes
anybody’s picture

anybody
Primary language German
Location Porta Westfalica
commented
Issue summary: View changes
thomas.frobieter’s picture

thomas.frobieter
Primary language German
Location EU
commented

Example usage: Use the 'before-show' step event to trigger the required clicks to make anything visible (e.g. a submenu trail or an expandable element) before the tip is shown on something inside this originally hidden element.

anybody’s picture

anybody
Primary language German
Location Porta Westfalica
commented

@grevil: Could you please check if it's possible to subscribe on the step events from Shepherd.js within 

$(document).on('drupalTourStarted', function() {
  // tour == Shepherd
  let tour = Drupal.tour.get();
  // @todo: subscribe to tour events
});

If yes, we should add some of these snippets to the README for the Shepherd tour and step events! Then it wouldn't need further triggers here.

PS: please note that you may probably need to use jQuery, as I think to remember that $().trigger doesn't trigger native JS events. Maybe we could also add a vanilla js trigger besides the jQuery one, if I'm correct.

anybody’s picture

anybody
Primary language German
Location Porta Westfalica
commented
Status: Active » Closed (works as designed)

@thomas.frobieter this is already possible, as @grevil found out. Here's a nice code example how to get the steps once the tour is started:
https://git.drupalcode.org/project/tour_extras/-/blob/1.x/modules/tour_e...

Now that this issue is closed, please review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, please credit people who helped resolve this issue.

smustgrave’s picture

smustgrave commented
Status: Closed (works as designed) » Needs work

Can we re-purpose this ticket to add that module to the README.

  • smustgrave committed 16b73272 on 2.0.x 
    [#3548508] feat: Add triggers for tour steps?

By: anybody
By: thomas....
smustgrave’s picture

smustgrave commented
Title: Add triggers for tour steps? » Update README for next tours extra module
Status: Needs work » Fixed

Added to the README and credited everyone from the tours extra module

Now that this issue is closed, please review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, please credit people who helped resolve this issue.

anybody’s picture

anybody
Primary language German
Location Porta Westfalica
commented

Thank you!!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.