Interface: SpotlightTour

Defined in: package/src/lib/SpotlightTour.context.ts:226

Properties

current?

optional current: number

Defined in: package/src/lib/SpotlightTour.context.ts:230

The current step index.

goTo()

goTo: (index) => void

Defined in: package/src/lib/SpotlightTour.context.ts:236

Moves to a specific step.

Parameters

index

number

the index of the step to go

Returns

void

next()

next: () => void

Defined in: package/src/lib/SpotlightTour.context.ts:240

Goes to the next step, if any. Stops the tour on the last step.

Returns

void

pause()

pause: () => void

Defined in: package/src/lib/SpotlightTour.context.ts:244

Pauses the tour execution.

Returns

void

previous()

previous: () => void

Defined in: package/src/lib/SpotlightTour.context.ts:248

Goes to the previous step, if any.

Returns

void

resume()

resume: () => void

Defined in: package/src/lib/SpotlightTour.context.ts:252

Resumes the tour execution.

Returns

void

start()

start: () => void

Defined in: package/src/lib/SpotlightTour.context.ts:256

Kicks off the tour from step 0.

Returns

void

status

status: TourStatus

Defined in: package/src/lib/SpotlightTour.context.ts:260

The current status of the tour.

stop()

stop: () => void

Defined in: package/src/lib/SpotlightTour.context.ts:264

Terminates the tour execution.

Returns

void