popover

Presents a popover when a given condition is true.

View ModifieriOS 13.0+macOS 10.15+

Overloads

2 ways to call compose().popover(). Each is one SwiftUI overload, picked by the arguments you pass.

React
compose().popover({
  isPresented: Binding<boolean>,
  attachmentAnchor?: SwiftUI.PopoverAttachmentAnchor,
  arrowEdge?: SwiftUI.Edge | null,
  content: ReactNode,
})
Swift
@export(implementation) nonisolated func popover<Content>(
    isPresented: Binding<Bool>,
    attachmentAnchor: PopoverAttachmentAnchor = .rect(.bounds),
    arrowEdge: Edge? = nil,
    @ContentBuilder content: @escaping () -> Content
) -> some View
where Content : View

Parameters

  • options.isPresented*Binding<boolean>

    A binding to a Boolean value that determines whether to present the popover content that you return from the modifier's content closure.

  • options.attachmentAnchorSwiftUI.PopoverAttachmentAnchor

    The positioning anchor that defines the attachment point of the popover. The default is Anchor.Source.bounds.

  • options.arrowEdgeSwiftUI.Edge | null

    The edge of the attachmentAnchor that defines the location of the popover's arrow. The default is nil, which results in the system allowing any arrow edge.

  • options.content*ReactNode

    A closure returning the content of the popover.

Discussion

Use this method to show a popover with contents that are a SwiftUI view, which you provide when a bound Boolean variable is true. In the example below, a popover displays whenever the user toggles the isShowingPopover state variable by pressing the "Show Popover" button:

struct PopoverExample: View {
    @State private var isShowingPopover = false
```swift

var body: some View {
    Button("Show Popover") {
        self.isShowingPopover = true
    }
    .popover(isPresented: $isShowingPopover) {
        Text("Popover Content")
            .padding()
    }
}

}


> **Important:** Prior to iOS 18.1, the popover arrow edge was not

respected. Apps that are re-compiled with the iOS 18.1 or later SDK or
visionOS 2.1 or later SDK and run on iOS 18.1 or later or visionOS 2.1
or later have the arrow edge respected. On macOS, arrow edge has always
been respected. Alternatively, to allow the system to choose the
best orientation of the popover's arrow, use the
[`View.popover(isPresented:attachmentAnchor:content:)`](/docs/modifiers/popover) variant.

On iPhone, popovers adapt into sheets. In vertically compact environments, such as iPhone in
landscape orientation, a popover presentation automatically adapts to appear as a
full-screen cover. Use the [`View.presentationCompactAdaptation(_:)`](/docs/modifiers/presentationcompactadaptation) or
[`View.presentationCompactAdaptation(horizontal:vertical:)`](/docs/modifiers/presentationcompactadaptation) modifier to
override this behavior.

### Breakthrough effect

In visionOS, most system presentations appear with a breakthrough effect by
default. To change how the enclosing presentation breaks through
content occluding it, use `presentationBreakthroughEffect(_:)`,
like in the following example:

```swift
.popover(isPresented: $isShowingPopover) {
    Text("Popover Content")
        .padding()
        .presentationBreakthroughEffect(.prominent)
}

See also

More in Presentation.