React Native Spotlight Tour - API Reference


React Native Spotlight Tour - API Reference / AttachStepProps

Interface: AttachStepProps

Defined in: package/src/lib/components/attach-step/AttachStep.component.tsx:32

Properties

children

children: ReactElement<ChildProps>

Defined in: package/src/lib/components/attach-step/AttachStep.component.tsx:37

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


fill?

optional fill: boolean

Defined in: package/src/lib/components/attach-step/AttachStep.component.tsx:51

When AttachStep wraps a Functional Component, it needs to add an additional 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 property has no effect when it’s applied to native components or components created using React.forwardRef, which pass the ref to another native component.

Default

false

index

index: number | number[]

Defined in: package/src/lib/components/attach-step/AttachStep.component.tsx:56

The index of the steps array to which the step is attached to. It can be a single index or multiple ones.


style?

optional style: StyleProp<ViewStyle>

Defined in: package/src/lib/components/attach-step/AttachStep.component.tsx:60

Style applied to AttachStep wrapper