Magidoc

TutorialStep
Object

A single step of an in-app tutorial. An anchored step spotlights a UI element; a step with no anchor is shown as a centered modal.

Fields

#

advanceOnClick

Boolean !
Non-null

When true, the user advances the tour by pressing the highlighted element (the Next button is hidden). Ignored for modal steps.

anchorId

String

The stable anchor id of the UI element this step points at (from the manager anchor registry). Null means the step is shown as a centered modal with no spotlight.

body

String !
Non-null

The step body copy shown in the popover.

order

Int !
Non-null

The zero-based position of this step within the tutorial.

placement

TutorialStepPlacement !
Non-null

Which side of the anchored element the popover is placed on. Ignored for modal steps.

spotlight

Boolean !
Non-null

Whether the anchored element is highlighted with a spotlight overlay. Ignored for modal steps.

title

String !
Non-null

The step title shown in the popover header.

Usages

#

References

#