React Native Spotlight Tour - API Reference / AttachStepProps

Interface: AttachStepProps<T>

Type parameters

Name
T

Table of contents

Properties

• children
• fill
• index

Properties

children

• children: ReactElement<ChildProps<T>, string | JSXElementConstructor<any>>

The element in which the spotlight will be to wrapped to in the specified step of the tour.

Defined in

package/src/lib/components/attach-step/AttachStep.component.tsx:26

---

fill

• Optional fill: boolean

When AttachStep wraps a Functional Component, it needs to add an aditional View on top of it to be able to measure the layout upon render. This prop allows to define the behavior of the width of such View. When set to false, it adjusts to its contents, when set to true, it stretches out and tries to fill it view.

Note: This prop has no effect when wrapping native components or componentes created with React.forwardRef, which pass the ref to another native component.

Default

false

Defined in

package/src/lib/components/attach-step/AttachStep.component.tsx:40

---

index

• index: number

The index of the steps array to which the step is attatched to.

Defined in

package/src/lib/components/attach-step/AttachStep.component.tsx:44