NSInterfaceViewController

public struct NSInterfaceViewController : NSViewControllerRepresentable

The NSInterfaceViewController struct helps you to use AppKit NSViewController or its derived class in project using SwiftUI. NSInterfaceViewController is a type that represents part of your app’s user interface using AppKit and provides modifiers that you use to configure views.

You create custom views by declaring types that conform to the View protocol. Implement the required View/body-swift.property computed property to provide the content for your custom view. Then you can present your AppKit ViewController View by using NSInterfaceViewController(MyViewController()) , as follows.

struct MyView: View {
    var body: some View {
        NSInterfaceViewController(MyViewController())
    }
}

The View protocol provides a large set of modifiers, defined as protocol methods with default implementations, that you use to position and configure views in the layout of your app. Modifiers typically work by wrapping the view instance on which you call them in another view with the specified characteristics. For example, adding the View/opacity(_:) modifier to a interface view returns a new view with some amount of transparency:

NSInterfaceViewController(MyViewController())
    .opacity(0.5) // Display partially transparent interface view.

It is recommended to use ZStack with NSInterfaceViewController , as follows.

ZStack {
    NSInterfaceViewController(MyViewController())
    MySwiftUIView()
}

A wrapper that you use to integrate an AppKit view controller into your SwiftUI interface.

Use an NSViewControllerRepresentable instance to create and manage an doc://com.apple.documentation/documentation/AppKit/NSViewController 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 NSViewControllerRepresentable 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 NSViewControllerRepresentable/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.