React Native Spotlight Tour - API Reference / SpotlightTour
Interface: SpotlightTour
Table of contents
Properties
Properties
current
• Optional current: number
The current step index.
Defined in
package/src/lib/SpotlightTour.context.ts:160
goTo
• goTo: (index: number) => void
Type declaration
▸ (index): void
Moves to a specific step.
Parameters
| Name | Type | Description |
|---|---|---|
index |
number |
the index of the step to go |
Returns
void
Defined in
package/src/lib/SpotlightTour.context.ts:166
next
• next: () => void
Type declaration
▸ (): void
Goes to the next step, if any. Stops the tour on the last step.
Returns
void
Defined in
package/src/lib/SpotlightTour.context.ts:170
previous
• previous: () => void
Type declaration
▸ (): void
Goes to the previous step, if any.
Returns
void
Defined in
package/src/lib/SpotlightTour.context.ts:174
start
• start: () => void
Type declaration
▸ (): void
Kicks off the tour from step 0.
Returns
void
Defined in
package/src/lib/SpotlightTour.context.ts:178
stop
• stop: () => void
Type declaration
▸ (): void
Terminates the tour execution.
Returns
void