Appearance
Multi-page tours
One tour can walk a visitor across several pages. Each step can belong to its own page, the SDK saves where the visitor is, and the tour carries on after a page change, in another tab or on another device.
Put a step on a page
In the step's Pages, targets and completion section:
- Same page as the step before (the default). Switch it off to give the step its own page rule: is exactly, starts with, contains, matches pattern (
*is one path segment,**any depth) or regex. - Button takes the visitor to: a path or URL. When the next step is on another page, this step's button goes there. Button text when it leads to another page replaces the button label.
Until the visitor is on a matching page, nothing shows. When they arrive, the tour continues from that step. Call init() on every page, or use trackRouteChanges: true in a single-page app, so the SDK can check again after each navigation.
A multi-page tour that is interrupted by navigation is paused, not dismissed. Its place is saved. A tour with no per-step pages still counts a navigation away as dismissing it, as before.
Progress is kept on the server
The SDK saves the current step (and what happened on each step) for each person. That is what lets a tour resume after a reload, and it follows the person to another browser once they identify(). When a person returns after a while, the tour continues from where they stopped.
To start one person over, use Start one person over in the tour's Results tab, or Restart next to a tour in a customer's Insights in the chat inbox.
Find the element by text or role
A tooltip can list more ways to find its element, tried in order after the selector: visible text (button, link, label or any element), an ARIA role with an accessible name, a data-jcx anchor, or a CSS selector. Text and role targets keep working when generated class names change. A tooltip needs at least one of: a selector, or one of these.
Required steps and skip reasons
Mark a step Required. When a visitor closes it, they pick a reason first (set the list in the tour's Settings tab, Targeting section, Skip reasons; defaults: Not relevant, Already done, Later). The reasons appear per step in Results.
Results
Results shows started, finished, finished with skips, abandoned (no activity for 7 days), the biggest drop-off (with its page), a per-step table (reached, skipped by reason, target missing, median time) and a split by any user trait you send with identify(), for example plan.