React Native Spotlight Tour - API Reference


React Native Spotlight Tour - API Reference / TooltipProps

Interface: TooltipProps

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

Configuration object which accepts Floating Ui middleware, placement and sameScrollView configurations.

Extended by

Properties

arrow?

optional arrow: number | boolean | ArrowOptions

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

Tooltip arrow options. It accepts 3 types of value:

  • boolean: When false, disable rendering the arrow. While true renders using the default values.
  • number: Use it to change the size of the arrow only.
  • object: Options to further customize the arrow style.

Default

20

flip?

optional flip: boolean | FlipOptions

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

Enables flipping the placement of the tooltip in order to keep it in view.

Default

true

offset?

optional offset: number

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

Offset points between the tooltip and the spotlight.

Default

4

placement?

optional placement: Placement

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

The placement of the tooltip relative to the spotlight.

Default

"bottom"

shift?

optional shift: boolean | ShiftOptions

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

Enables shifting the tooltip in order to keep it in view.

Default

{ padding: 8 }