Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
React Native docs
NavigationReact Native

Tour

Guide users through controlled steps around measured native targets.

Public APILumenTourReact Native

Native example

Use Tour

Hosts measure targets relative to the native Tour container. Missing or offscreen targets retain dismissible guidance. Controlled indices and host data are never rewritten.

View captured React Native example
Tour rendered in the Expo web renderer Lumen playground
Captured exampleExpo web renderer
tsx
<LumenTour label="Guide" steps={steps} anchors={anchors} open={open} onOpenChange={setOpen} index={index} onIndexChange={setIndex} onFinish={finish}>{content}</LumenTour>

Reference

Public API

The primary shared and platform-specific options exposed by LumenTour.

APIValues or typeDefaultDescription
steps / anchors / open / indexStable steps / measured rectangles / controlled stateRequiredControls guidance around host-native layout targets.

Native behavior

Design and accessibility

When to use it

Hosts measure targets relative to the native Tour container. Missing or offscreen targets retain dismissible guidance. Controlled indices and host data are never rewritten.

Accessibility

Named native guidance with measured target highlights and always usable dismissal.

Shared component

Available on other platforms

Apple / SwiftUIAndroid / Compose
React Native docsNative primitives