Protocol

UIViewControllerRepresentable

A view that represents a UIKit view controller.

Declaration

protocol UIViewControllerRepresentable where Self.Body == Never

Overview

Use a UIViewControllerRepresentable instance to create and manage a UIViewController object in your SwiftUI interface. Adopt this protocol in one of your app's custom instances, and use its methods to create, update, and tear down your view controller. The creation and update processes parallel the behavior of SwiftUI views, and you use them to configure your view controller with your app's current state information. Use the teardown process to remove your view controller cleanly from your SwiftUI. For example, you might use the teardown process to notify other objects that the view controller is disappearing.

To add your view controller into your SwiftUI interface, create your UIViewControllerRepresentable instance and add it to your SwiftUI interface. The system calls the methods of your custom instance at appropriate times.

The system doesn't automatically communicate changes occurring within your view controller to other parts of your SwiftUI interface. When you want your view controller to coordinate with other SwiftUI views, you must provide a Coordinator instance to facilitate those interactions. For example, you use a coordinator to forward target-action and delegate messages from your view controller to any SwiftUI views.

Topics

Creating and Updating the View Controller

func makeUIViewController(context: Self.Context) -> Self.UIViewControllerType

Creates the view controller object and configures its initial state.

Required.

func updateUIViewController(Self.UIViewControllerType, context: Self.Context)

Updates the state of the specified view controller with new information from SwiftUI.

Required.

struct UIViewControllerRepresentableContext

Contextual information about the state of the system that you use to create and update your UIKit view controller.

associatedtype UIViewControllerType

The type of view controller to present.

Required.

Cleaning Up the View Controller

static func dismantleUIViewController(Self.UIViewControllerType, coordinator: Self.Coordinator)

Cleans up the presented view controller (and coordinator) in anticipation of their removal.

Required. Default implementation provided.

Providing a Custom Coordinator Object

func makeCoordinator() -> Self.Coordinator

Creates the custom instance that you use to communicate changes from your view controller to other parts of your SwiftUI interface.

Required. Default implementation provided.

associatedtype Coordinator

A type to coordinate with the view controller.

Required.

Relationships

Inherits From

See Also

UIKit Hosting

class UIHostingController

A UIKit view controller that manages a Swift UI view hierarchy.

protocol UIViewRepresentable

A wrapper for a UIKit view that you use to integrate that view into your SwiftUI view hierarchy.