Skip to content

Methods

MethodReturns
start(at?)PromiseOpens the tour. at is a step index or id.
next() / back()PromiseMove one step, skipping any whose when() is false.
goTo(indexOrId)PromiseJump to a step.
complete() / cancel()PromiseEnd the tour. Only complete() counts for remember.
refresh()voidRecompute position and spotlight without changing step.
destroy()voidEnds the tour and rips out its DOM. Call this on unmount.
index / current / isActivegettersCurrent state.
Tour.hasCompleted(id)booleanStatic. Reads the remember flag.
Tour.clearCompleted(id)voidStatic. Lets a user replay the tour.