Skip to content

Concepts

Completion rules

[object Object]

RuleThe step completes whenUse it for
tap_anchorThe user taps or clicks the spotlighted elementButtons and links: the most natural rule
eventYour app calls track with the step's event nameThings that finish later, like a saved form
next_buttonThe user presses Next on the cardExplanations without an action
manualYour code calls complete with the step's idAnything else
JSON
{ "complete_on": { "type": "event", "name": "client_selected" } }
TypeScript
// After the user picks a client:
playstep.track('client_selected')

// Or complete a manual step by its id:
playstep.complete('fill-client')

tap_anchor listens before your own click handlers run, so the step completes even if the tap navigates to another page. A tap_anchor step needs an anchor.

While a step waits for the user, the card says Waiting for you. next_button steps show Next (or Done on the last step), and every step after the first has Back. The close button ends the guide at any time.

Search the docs and guides.

PlayStep is coming soon

We're opening PlayStep to teams one at a time. Leave your name and email and we'll set up a demo.

We use your email only to arrange the demo. See the privacy policy.