A set of utilities for more pleasant work with ExtensionKit
dependencies: [
.package(url: "https://github.com/ChimeHQ/Extendable", from: "0.1.0")
],
targets: [
.target(
name: "ExtensionSide",
dependencies: ["Extendable"]
),
.target(
name: "HostSide",
dependencies: [.product(name: "ExtendableHost", package: "Extendable")]
),
]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
}
}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.
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)
}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.
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)
}
}
}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)Currently, the init in the AppExtention protocol lacks any isolation. This makes it difficult to initialize instance variables if you are relying on the true-but-unexpressed @MainActor isolation of extensions. I've included a workaround that can help. SE-0414 will make this unecessary, as will ExtensionFoundation adding annotations. In the mean time though, it's nice to have no warnings.
@main
final class MyExtension: AppExtension {
@InitializerTransferred private var value: MainActorType
nonisolated init() {
self._value = InitializerTransferred(mainActorProvider: {
MainActorType()
})
}
}I would love to hear from you! Issues or pull requests work great. A Discord server is also available for live help, but I have a strong bias towards answering in the form of documentation.
I prefer collaboration, and would love to find ways to work together if you have a similar project.
I prefer indentation with tabs for improved accessibility. But, I'd rather you use the system you want and make a PR than hesitate because of whitespace.
By participating in this project you agree to abide by the Contributor Code of Conduct.