React Native Spotlight Tour - API Reference

---

React Native Spotlight Tour - API Reference / TourBoxProps

Interface: TourBoxProps

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:8

Extends

• RenderProps

Properties

backStyle?

optional backStyle: StyleProp<ViewStyle>

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:12

Back button styles.

---

backText?

optional backText: string

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:18

Back button text.

Default

Back

---

children?

optional children: ReactNode

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:22

The TourBox content.

---

current

current: number

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

The index of the current step the tour is on.

Inherited from

RenderProps.current

---

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

Inherited from

RenderProps.goTo

---

hideBack?

optional hideBack: boolean

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:26

Should hide the Back button.

---

hideNext?

optional hideNext: boolean

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:30

Should hide the Next button.

---

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.

Inherited from

RenderProps.isFirst

---

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.

Inherited from

RenderProps.isLast

---

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

Inherited from

RenderProps.next

---

nextStyle?

optional nextStyle: StyleProp<ViewStyle>

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:34

Next button styles.

---

nextText?

optional nextText: string

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:40

Next button text.

Default

Next

---

onBack()?

optional onBack: () => void

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:44

Callback for when the Back button is pressed.

Returns

void

---

onNext()?

optional onNext: () => void

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:48

Callback for when the Next button is pressed.

Returns

void

---

onPause()?

optional onPause: () => void

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:52

Callback for when the Pause button is pressed.

Returns

void

---

pause()

pause: () => void

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

Pauses the tour execution.

Returns

void

Inherited from

RenderProps.pause

---

pauseStyle?

optional pauseStyle: StyleProp<ViewStyle>

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:56

Back button styles.

---

pauseText?

optional pauseText: string

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:60

Pause button text.

---

previous()

previous: () => void

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

Goes to the previous step, if any.

Returns

void

Inherited from

RenderProps.previous

---

resume()

resume: () => void

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

Resumes the tour execution.

Returns

void

Inherited from

RenderProps.resume

---

showPause?

optional showPause: boolean

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:64

Should show the Pause button.

---

stop()

stop: () => void

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

Terminates the tour execution.

Returns

void

Inherited from

RenderProps.stop

---

style?

optional style: StyleProp<ViewStyle>

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:68

TourBox main container styles.

---

title?

optional title: string

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:72

TourBox title text.

---

titleStyle?

optional titleStyle: StyleProp<TextStyle>

Defined in: package/src/lib/components/tour-box/TourBox.component.tsx:76

TourBox title styles.