When to use it
Branches browse and enabled selectable leaves emit full canonical paths. Retain unknown paths until the host replaces them. Read-only selection permits browsing; app routing stays in the host.
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 Cascader
Branches browse and enabled selectable leaves emit full canonical paths. Retain unknown paths until the host replaces them. Read-only selection permits browsing; app routing stays in the host.
LumenCascader("Destination", nodes: nodes, selectedPath: $path)Reference
Public API
The primary shared and platform-specific options exposed by LumenCascader.
| API | Values or type | Default | Description |
|---|---|---|---|
| nodes / selectedPath | LumenTreeNode records / controlled ordered IDs | Required | Controls a canonical path over the validated shared tree model. |
| readOnly / loading / error | Platform state values | Editable / ready / no error | Guards selection and hides stale result controls. |
| backLabel / formatDisclosure | Localized text / formatter | English defaults | Names native drill-down navigation. |
Native behavior
Design and accessibility
Accessibility
Localized branch and back navigation with controlled leaf selection and safe status states.
Shared component