fullScreenCover

Presents a modal view that covers as much of the screen as possible when binding to a Boolean value you provide is true.

View ModifieriOS 14.0+tvOS 14.0+watchOS 7.0+

Overloads

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

React
compose().fullScreenCover({
  isPresented: Binding<boolean>,
  onDismiss?: (() => void) | null,
  content: ReactNode,
})
Swift
nonisolated func fullScreenCover<Content>(
    isPresented: Binding<Bool>,
    onDismiss: (() -> Void)? = 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 sheet.

  • options.onDismiss(() => void) | null

    The closure to execute when dismissing the modal view.

  • options.content*ReactNode

    A closure that returns the content of the modal view.

Discussion

Use this method to show a modal view that covers as much of the screen as possible. The example below displays a custom view when the user toggles the value of the isPresenting binding:

struct FullScreenCoverPresentedOnDismiss: View {
    @State private var isPresenting = false
    var body: some View {
        Button("Present Full-Screen Cover") {
            isPresenting.toggle()
        }
        .fullScreenCover(isPresented: $isPresenting,
                         onDismiss: didDismiss) {
            VStack {
                Text("A full-screen modal view.")
                    .font(.title)
                Text("Tap to Dismiss")
            }
            .onTapGesture {
                isPresenting.toggle()
            }
            .foregroundColor(.white)
            .frame(maxWidth: .infinity,
                   maxHeight: .infinity)
            .background(Color.blue)
            .ignoresSafeArea(edges: .all)
        }
    }

    func didDismiss() {
        // Handle the dismissing action.
    }
}

See also

More in Presentation.