Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Apple docs
NavigationApple

Tour

Guide users through controlled steps around measured native targets.

Public APILumenTourApple / SwiftUISwift product: LumenUI

Apple availability

Supported native targets

Import LumenUI in the target that uses this component. iPad support follows the iOS package baseline and uses native iPad layout behavior.

iPhone · iOS 16+iPad · iPadOS 16+Mac · macOS 13+Apple Vision · visionOS 1+

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 iPhone simulator Lumen playground
Captured exampleiPhone simulator
swift
LumenTour("Guide", steps: steps, anchors: anchors, open: $open, index: $index, onFinish: 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 NativeAndroid / Compose
Apple docsSwiftUI package