Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Android docs
NavigationAndroid

Tour

Guide users through controlled steps around measured native targets.

Public APILumenTourAndroid / Compose

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.

Tour rendered in the Android phone emulator Lumen playground
Captured exampleAndroid phone emulator
kotlin
LumenTour("Guide", steps, anchors, open, onOpenChange, index, onIndexChange, finish) { content() }

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

React NativeApple / SwiftUI
Android docsCompose module