An arrangement view style that layers the primary view over the
secondary view in z-order.
The overlay arrangement is well-suited for full screen experiences
like media players or in-call interfaces, where prominent controls
are layered over background content. When the context changes,
such as when a foldable device is folded, the overlay can transition
its views into a side-by-side layout along one or more axes.
Customize which axes are supported using
``OverlayArrangementViewStyle/axes(_:)``.
Creates an overlay arrangement that supports laying out its
views along the given axes.
For example, you could add an overlay arrangement which will only
lay out its views vertically using the `vertical` axis.
ArrangementView {
PrimaryContent()
} secondary: {
SecondaryContent()
}
.arrangementViewStyle(.overlay.axes(.vertical))
- Parameter axes: The axes the arrangement can lay out views along
when it can no longer remain overlaid.
init · iOS 27.1+
init
TypeScript
static init(): OverlayArrangementViewStyle
Swift declaration
nonisolated init()
Skipped declarations
1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.
