DocsBuilding tours

Display conditions

Show a tour only on certain devices, dates, after other tours, or when elements exist.

Display conditions decide whether a tour appears on a matching page. Find them under Display options on the Setup tab. A tour with no conditions shows to everyone on matching pages.

Device

Web Show on Desktop & mobile (default), Desktop only or Mobile only. Phones and tablets, including iPads, count as mobile.

Date range

Show within a date range — set a From date, a To date, or both. The tour shows from the start of the From day to the end of the To day, in the visitor’s local time. Handy for announcing a feature for a couple of weeks.

Prior tours

Show only if user has seen or completed another tour on the same site. Use it to chain tours: a basics tour first, then an advanced tour only for people who finished it. Add several and toggle AND / OR to combine them.

Element conditions

Show only if element matches a selector with one of these rules:

RulePasses when
existsan element matching the selector is in the page
not_existsno element matches
visiblea matching element exists and is visible
not_visibleno matching element is visible

Add several conditions and toggle AND / OR. Element conditions are re-checked continuously, so they react to tab switches, opened panels and client-side navigation without a reload. That makes them the way to scope tours more tightly than a page path — for example one tour per tab of a settings page:

Two tours, same page path
Tour "Profile tab"   page: /settings   show only if [data-tour="profile-panel"] is visible
Tour "Billing tab"   page: /settings   show only if [data-tour="billing-panel"] is visible

How conditions are evaluated

  • Device, date and prior-tour conditions are checked once when the page loads.
  • Element conditions are re-checked while the visitor is on the page; when they stop passing, the tour UI is removed, and when they pass again it comes back (without auto-launching a second time).
  • All condition groups must pass for the tour to show.
Note
In the iOS, Android and React Native SDKs, use the Screen field to scope tours; the device condition is for websites.
Something missing or unclear? Tell us and we’ll fix the page.