LavaUI docs GitHub

struct OverlayView

Swift

struct OverlayView<Content, OverlayContent> where Content : View, OverlayContent : View

content.overlay(isPresented:) { ... }

Sources/LavaUI/Overlay.swift:218

Constructors

init(content: Content, isPresented: Binding<Bool>, alignment: OverlayAlignment, placement: OverlayPlacement? = nil, style: OverlayStyle, overlayContent: OverlayContent)

Creates a popup overlay. Usually spelled .overlay(isPresented:alignment:style:content:).

Sources/LavaUI/Overlay.swift:234

Properties

var alignment: OverlayAlignment

Where the popup sits relative to the presenter, when placement is nil.

Sources/LavaUI/Overlay.swift:227

var content: Content

The presenting view, laid out normally.

Sources/LavaUI/Overlay.swift:220

var dumpDetail: String { get }

Not documented.

Sources/LavaUI/Overlay.swift:250

var isPresented: Binding<Bool>

Whether the popup is shown. Set to false when it is dismissed by a click outside or Escape.

Sources/LavaUI/Overlay.swift:225

var overlayContent: OverlayContent

The popup's content.

Sources/LavaUI/Overlay.swift:222

var placement: OverlayPlacement?

Custom placement that replaces alignment, or nil.

Sources/LavaUI/Overlay.swift:229

var style: OverlayStyle

Panel styling for the floating surface itself.

Sources/LavaUI/Overlay.swift:231

Methods

func mountPrimitive() -> any AnyViewNode

Not documented.

Sources/LavaUI/Overlay.swift:262

func reconcilePrimitive(_ node: any AnyViewNode) -> any AnyViewNode

Not documented.

Sources/LavaUI/Overlay.swift:270

func structureLines(indent: Int = 0) -> [String]

Not documented.

Sources/LavaUI/Overlay.swift:252