React Native Spotlight Tour - API Reference / RenderProps
Interface: RenderProps
Hierarchy
-
RenderProps
Table of contents
Properties
Properties
current
• current: number
The index of the current step the tour is on.
Defined in
package/src/lib/SpotlightTour.context.ts:24
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:30
isFirst
• isFirst: boolean
Set to true if the tour is on the first step, false otherwise.
Defined in
package/src/lib/SpotlightTour.context.ts:34
isLast
• isLast: boolean
Set to true if the tour is on the last step, false otherwise.
Defined in
package/src/lib/SpotlightTour.context.ts:38
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:42
previous
• previous: () => void
Type declaration
▸ (): void
Goes to the previous step, if any.
Returns
void
Defined in
package/src/lib/SpotlightTour.context.ts:46
stop
• stop: () => void
Type declaration
▸ (): void
Terminates the tour execution.
Returns
void