Guided Tour
This module allows administrators to create and manage interactive, step-by-step tours for their Drupal sites through a user interface, without needing to write any code. Tours can be customized based on user roles and specific pages, and even target specific content types.
Features
Guided Tour provides step-by-step interactive tours for Drupal sites
using Driver.js. Administrators can create tours through a UI without
writing code. Key features:
- Role-based tours (show different tours per role)
- Route-based targeting (specific pages or all pages)
- Bundle filter (target specific content types)
- Shadow DOM / Web Components support
- Configurable dismissal cookie
- Replay button block (FAB or inline)
- Multilingual-ready (config_translation)
Post-Installation
Go to Administration > Configuration > User Interface > Guided Tour
and click Add tour. Define steps in YAML format with CSS selectors,
popover positions, and button labels.
Additional Requirements
Requires Driver.js v1.4.x (MIT license), installed automatically
via Composer into /libraries/driver.js/.
Chrome Extension
A companion Chrome extension
is available to help you build tours faster — it lets you click any
element on the page to copy its CSS selector, ready to paste into the
YAML editor.
Similar projects
Drupal core includes a Tour module, but it requires custom plugin
code per tour. Guided Tour uses a YAML-based UI, supports anonymous
users, Web Components, and role/bundle targeting with no coding required.
Depends on
Dependencies of the latest stable release
- user Drupal core
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.