React Native Spotlight Tour - API Reference / TourBoxProps

Interface: TourBoxProps

Hierarchy

• RenderProps

  ↳ TourBoxProps

Table of contents

Properties

• backStyle
• backText
• children
• current
• goTo
• hideBack
• hideNext
• isFirst
• isLast
• next
• nextStyle
• nextText
• onBack
• onNext
• previous
• stop
• style
• title
• titleStyle

Properties

backStyle

• Optional backStyle: StyleProp<ViewStyle>

Back button styles.

Defined in

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

---

backText

• Optional backText: string

Back button text.

Default

Back

Defined in

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

---

children

• Optional children: ReactNode

The TourBox content.

Defined in

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

---

current

• current: number

The index of the current step the tour is on.

Inherited from

RenderProps.current

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

Inherited from

RenderProps.goTo

Defined in

package/src/lib/SpotlightTour.context.ts:30

---

hideBack

• Optional hideBack: boolean

Should hide the Back button.

Defined in

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

---

hideNext

• Optional hideNext: boolean

Should hide the Next button.

Defined in

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

---

isFirst

• isFirst: boolean

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

Inherited from

RenderProps.isFirst

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.

Inherited from

RenderProps.isLast

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

Inherited from

RenderProps.next

Defined in

package/src/lib/SpotlightTour.context.ts:42

---

nextStyle

• Optional nextStyle: StyleProp<ViewStyle>

Next button styles.

Defined in

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

---

nextText

• Optional nextText: string

Next button text.

Default

Next

Defined in

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

---

onBack

• Optional onBack: () => void

Type declaration

▸ (): void

Callback for when the Back button is pressed.

Returns

void

Defined in

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

---

onNext

• Optional onNext: () => void

Type declaration

▸ (): void

Callback for when the Next button is pressed.

Returns

void

Defined in

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

---

previous

• previous: () => void

Type declaration

▸ (): void

Goes to the previous step, if any.

Returns

void

Inherited from

RenderProps.previous

Defined in

package/src/lib/SpotlightTour.context.ts:46

---

stop

• stop: () => void

Type declaration

▸ (): void

Terminates the tour execution.

Returns

void

Inherited from

RenderProps.stop

Defined in

package/src/lib/SpotlightTour.context.ts:50

---

style

• Optional style: StyleProp<ViewStyle>

TourBox main container styles.

Defined in

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

---

title

• Optional title: string

TourBox title text.

Defined in

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

---

titleStyle

• Optional titleStyle: StyleProp<TextStyle>

TourBox title styles.

Defined in

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