Create guided product tours directly from your tests. Tours are rendered as HTML overlays that walk the user through elements. The exported files are standalone and can be shared or embedded in test reports.
What you will learn
- How to create and export a tour.
- Which tour themes are available.
- How to play a tour and common use cases.
Basic tour#
Tour themes#
The crate supports several JavaScript tour libraries:
TourTheme::ShepherdTourTheme::IntroJsTourTheme::DriverJsTourTheme::BootstrapTourTheme::Hopscotch
Use create_tour_with_theme(name, theme) to set the theme explicitly, or use a
convenience constructor such as create_introjs_tour(name).
Play a tour#
Exported tours are standalone HTML files. Open them in a browser to play the tour, or serve them from your test report.
Use cases#
- Onboarding flows.
- Interactive documentation.
- Demo and presentation walkthroughs.
Troubleshooting#
Tour element not highlighted
Likely cause. Selector is hidden or inside Shadow DOM.
Fix. Ensure the element is visible or use a shadow-aware selector.
Export file is empty
Likely cause. No steps added.
Fix. Call add_tour_step before export_tour.
Theme styling missing
Likely cause. Offline environment.
Fix. Use a theme that bundles CSS or serve the file with internet access.