Magidoc

TutorialStepInput
Input Object

A single step of a tutorial. Omit anchorId for a centered modal step.

Fields

#

advanceOnClick

Boolean

Whether the user advances by pressing the highlighted element. Defaults to false.

anchorId

String

The anchor id from the manager anchor registry. Null/omitted renders a centered modal step.

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

Which side of the anchored element the popover is placed on. Defaults to BOTTOM.

spotlight

Boolean

Whether the anchored element is spotlighted. Defaults to true.

title

String !
Non-null

The step title shown in the popover header.