The core/jquery.joyride library has been deprecated as the JS library it uses - jQuery Joyride - is only minimally maintained, has not had a release for several years, and depends on jQuery 3 and it's uncertain if it will continue to work with jQuery 4. https://github.com/zurb/joyride/
The tour module now uses core/shepherd, which uses the actively maintained dependency-free ShepherdJS library: https://github.com/shipshapecode/shepherd
Impacts
Tour tip markup is structured differently
Shepherd and jQuery Joyride render tour tips differently. Note that this new markup structure won't occur with themes extending Stable or Stable 9, which deliver the Stable-theme backwards compatbile promise by converting Shepherd-structured markup to jQuery Joyride-structured markup.
For themes not extending Stable/Stable 9, Core CSS has been updated to account for these changes, so there should be no noticeable impact unless one of these is true:
- A site provides additional CSS that style the Tour Tips beyond what is provided in core.
- A site is using Tip plugins other than the one provided by core (the
textplugin)
If either of the above are true, Tour tip appearance may change. If these changes are undesirable, they may be addressed in one of two ways:
- Refactor existing CSS to account for the new markup structure.
- Configure site themes to extend a stable theme, or copy the tour.js file and have it load alongside Tour. If this file is present on a page, Tour's will render jQuery Joyride structured markup.
Tour configuration has changed
The location and attributes tour config properties have been deprecated. They are replaced with position and selector Additional details on this are provided in a separate change record https://www.drupal.org/node/3204093
This should have zero impact on site tours stored in config. Via an update hook, this config will be converted to use these new properties.
