Interface: RenderProps

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

Extended by

TourBoxProps

Properties

current

current: number

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

The index of the current step the tour is on.

goTo()

goTo: (index) => void

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

Moves to a specific step.

Parameters

index

number

the index of the step to go

Returns

void

isFirst

isFirst: boolean

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

Set to true if the tour is on the first step, false otherwise.

isLast

isLast: boolean

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

Set to true if the tour is on the last step, false otherwise.

next()

next: () => void

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

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:74

Pauses the tour execution.

Returns

void

previous()

previous: () => void

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

Goes to the previous step, if any.

Returns

void

resume()

resume: () => void

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

Resumes the tour execution.

Returns

void

stop()

stop: () => void

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

Terminates the tour execution.

Returns

void