Extendable

0.2.0

A set of utilities for more pleasant work with ExtensionKit
ChimeHQ/Extendable

What's New

v0.2.0

2023-04-14T22:47:53Z
  • renames the host-side library to ExtendableHost to be less-specific about just views
  • adds a small convenience init method to AppExtensionProcess to help with Sendability

Build Status License Platforms Documentation

Extendable

A set of utilities for more pleasant work with ExtensionKit

Global Connection

Setting up an ExtensionKit extension can be confusing, and requires a fair amount of boilerplate. ConnectableExtension makes it easier to manage the global host connection.

@main
final class ExampleExtension: ConnectableExtension {
    init() {
    }

    func acceptConnection(_ connection: NSXPCConnection) throws {
        // configure your global connection and possibly
        // store references to host interface objects
    }
}

Scenes

Dealing with View-based extensions is even more complex. And, there isn't a clear way to get access to the host connection in your views. Extendable comes with a few components that make it easier to build scenes and manage view connections.

ConnectingAppExtensionScene

This is a AppExtensionScene that makes it easier to get access to the scene's connection within your View.

ConnectingAppExtensionScene(sceneID: "one") { (sceneId, connection) in
    try ConnectionView(sceneId: sceneId, connection: connection)
}

AppExtensionSceneGroup

I expect this type won't be needed once Ventura ships. And, maybe it's just me, but I've been unable to figure out how to use AppExtensionSceneBuilder without a wrapper type. So here it is.

Example View

You can use ConnectingAppExtensionScene and AppExtensionSceneGroup independently, or as part of a more standard extension structure. But, if you want, you can also make use of the ConnectableSceneExtension protocol to really streamline your view class. Here's a full example:

@main
final class ViewExtension: ConnectableSceneExtension {
    init() {
    }

    func acceptConnection(_ connection: NSXPCConnection) throws {
        // handle global connection
    }
    
    var scene: some AppExtensionScene {
        AppExtensionSceneGroup {
            ConnectingAppExtensionScene(sceneID: "one") { (sceneId, connection) in
                try ConnectionView(sceneId: sceneId, connection: connection)
            }
            ConnectingAppExtensionScene(sceneID: "two") { (sceneId, connection) in
                try ConnectionView(sceneId: sceneId, connection: connection)
            }
        }
    }
}

struct ConnectionView: View {
    let sceneName: String
    let connection: NSXPCConnection?

    init(sceneId: String, connection: NSXPCConnection?) throws {
        self.sceneName = sceneId
        self.connection = connection
    }

    var value: String {
        return String(describing: connection)
    }

    var body: some View {
        VStack {
            Rectangle().frame(width: nil, height: 4).foregroundColor(.green)
            Spacer()
            Text("\(sceneName): \(value)")
            Spacer()
            Rectangle().frame(width: nil, height: 4).foregroundColor(.red)
        }
    }
}

ExtendableHost

Extendable also includes a second library called ExtendableHost.

You can its AppExtensionBrowserView and ExtensionHostingView to integrate the ExtensionKit view system with SwiftUI in your host application.

// very simple init extension to help with actor-isolation compatibility
let process = try await AppExtensionProcess(appExtensionIdentity: identity)

Suggestions or Feedback

We'd love to hear from you! Get in touch via twitter, an issue, or a pull request.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Description

  • Swift Tools 5.5.0
View More Packages from this Author

Dependencies

  • None
Last updated: Mon Oct 02 2023 09:51:37 GMT-0900 (Hawaii-Aleutian Daylight Time)