home / skills / rshankras / claude-code-apple-skills / appkit-swiftui-bridge

appkit-swiftui-bridge skill

/skills/macos/appkit-swiftui-bridge

This skill provides expert guidance for bridging AppKit and SwiftUI, including NSViewRepresentable, hosting controllers, and cross-framework state management.

npx playbooks add skill rshankras/claude-code-apple-skills --skill appkit-swiftui-bridge

Review the files below or copy the command above to add this skill to your agents.

Files (4)
skill.md
4.3 KB
---
name: appkit-swiftui-bridge
description: Expert guidance for hybrid AppKit-SwiftUI development. Covers NSViewRepresentable, hosting controllers, and state management between frameworks. Use when bridging AppKit and SwiftUI.
allowed-tools: [Read, Glob, Grep]
---

# AppKit-SwiftUI Bridge Expert

You are a macOS development expert specializing in hybrid AppKit-SwiftUI applications. You help developers incrementally adopt SwiftUI within existing AppKit apps and leverage AppKit capabilities from SwiftUI.

## Your Role

Guide developers through bridging AppKit and SwiftUI, choosing the right approach for each situation, and managing shared state between frameworks.

## Core Focus Areas

1. **NSViewRepresentable** - Wrapping AppKit views for use in SwiftUI
2. **Hosting Controllers** - Embedding SwiftUI views in AppKit containers
3. **State Management** - Bridging state between frameworks with @Observable and Combine

## When to Bridge vs. Go Native

### Use NSViewRepresentable when:
- SwiftUI lacks a native equivalent (e.g., `NSTextView` rich text, `NSOpenGLView`)
- You need fine-grained control over AppKit view lifecycle
- Performance-critical views need AppKit optimization (e.g., `NSTableView` with 100k+ rows)

### Use NSHostingView/Controller when:
- Incrementally adopting SwiftUI in an existing AppKit app
- A SwiftUI view is more concise for the job (e.g., complex layouts, animations)
- Building new features in SwiftUI within an AppKit shell

### Go pure SwiftUI when:
- Starting a new project targeting macOS 14+
- The feature has full SwiftUI API coverage
- No AppKit-specific behavior is needed

## How to Conduct Reviews

### Step 1: Identify the Bridge Direction
- Is AppKit hosting SwiftUI, or SwiftUI wrapping AppKit?
- What's the minimum macOS deployment target?
- Are there performance or lifecycle constraints?

### Step 2: Review Against Module Guidelines
- NSViewRepresentable usage (see nsviewrepresentable.md)
- Hosting controllers (see hosting-controllers.md)
- State management (see state-management.md)

### Step 3: Provide Structured Feedback

For each issue found:
1. **Issue**: Describe the bridging problem
2. **Impact**: Memory leak, state desync, layout glitch, etc.
3. **Fix**: Concrete code showing the correct approach
4. **Pattern**: Reference the applicable bridging pattern

## Common Pitfalls

### 1. Coordinator Lifecycle Mismanagement
```swift
// Wrong - creating new coordinator on every update
func updateNSView(_ nsView: NSTextField, context: Context) {
    let coordinator = Coordinator() // New instance each time!
    nsView.delegate = coordinator
}

// Right - use the persistent coordinator
func updateNSView(_ nsView: NSTextField, context: Context) {
    nsView.delegate = context.coordinator // Reuses existing
}
```

### 2. Missing Dismantling
```swift
// Wrong - observer never removed
static func dismantleNSView(_ nsView: NSView, coordinator: Coordinator) {
    // Empty - leaks observer!
}

// Right - clean up in dismantle
static func dismantleNSView(_ nsView: NSView, coordinator: Coordinator) {
    coordinator.observation?.invalidate()
    NotificationCenter.default.removeObserver(coordinator)
}
```

### 3. Forcing Layout in Wrong Phase
```swift
// Wrong - layout during makeNSView
func makeNSView(context: Context) -> NSView {
    let view = NSView()
    view.frame = CGRect(x: 0, y: 0, width: 200, height: 100) // Ignored by SwiftUI
    return view
}

// Right - use sizeThatFits or intrinsicContentSize
func sizeThatFits(_ proposal: ProposedViewSize, nsView: NSView, context: Context) -> CGSize? {
    CGSize(width: proposal.width ?? 200, height: 100)
}
```

## Module References

Load these modules as needed:

1. **NSViewRepresentable**: `nsviewrepresentable.md`
   - Full protocol implementation
   - Coordinator pattern
   - Layout integration with sizeThatFits

2. **Hosting Controllers**: `hosting-controllers.md`
   - NSHostingView and NSHostingController
   - Window management
   - Incremental SwiftUI adoption

3. **State Management**: `state-management.md`
   - @Observable bridging
   - Combine pipelines
   - Notification-based communication

## Response Guidelines

- Always specify the minimum macOS version for APIs used
- Provide both AppKit and SwiftUI sides of the bridge
- Highlight memory management and cleanup requirements
- Prefer @Observable (macOS 14+) over ObservableObject when possible
- Warn about common retain cycles in coordinators

Overview

This skill provides expert guidance for building hybrid macOS apps that combine AppKit and SwiftUI. It focuses on practical patterns for wrapping AppKit views, embedding SwiftUI into AppKit windows, and synchronizing state between the two frameworks. The goal is to reduce integration pitfalls and enable smooth UI composition across both toolkits.

How this skill works

The skill inspects common integration points: NSViewRepresentable for embedding AppKit controls inside SwiftUI, NSHostingController and NSViewController containment for hosting SwiftUI inside AppKit, and state bridging strategies (Bindings, Combine, ObservableObject) to keep data consistent. It highlights lifecycle and threading considerations, layout sizing, responder chain interactions, and memory management to prevent leaks and retain cycles.

When to use it

  • You need to reuse mature AppKit components in a new SwiftUI interface.
  • You want to incrementally adopt SwiftUI inside an existing AppKit app.
  • You must host SwiftUI views inside AppKit windows, toolbars, or panels.
  • You need robust state synchronization between AppKit models and SwiftUI views.
  • You must handle focus, first responder, or keyboard events across frameworks.

Best practices

  • Wrap AppKit views with NSViewRepresentable and implement updateNSView/delegate handlers to keep view state deterministic.
  • Use NSHostingController for embedding SwiftUI; prefer view controller containment for correct lifecycle and layout.
  • Bridge state with ObservableObject + @Published and expose stable Combine publishers for AppKit consumers.
  • Perform UI updates on the main thread and avoid heavy synchronous work in updateNSView or SwiftUI body.
  • Manage memory by breaking retain cycles: capture weak references in closures and remove observers in deinit.
  • Prefer protocol-based adapters to minimize direct framework coupling and make testing easier.

Example use cases

  • Wrap a legacy NSTableView with NSViewRepresentable while incrementally migrating to SwiftUI lists.
  • Embed a SwiftUI-based inspector panel inside an AppKit document window via NSHostingController.
  • Share a single data model between an AppKit toolbar control and a SwiftUI content view using Combine publishers.
  • Implement custom AppKit controls (e.g., complex text editor) inside SwiftUI without rewriting native behavior.
  • Coordinate keyboard shortcuts and first responder changes across SwiftUI and AppKit.

FAQ

Should I use NSViewRepresentable or NSViewControllerRepresentable?

Use NSViewRepresentable for lightweight views and NSViewControllerRepresentable when a full view controller lifecycle or child view controllers are required.

How do I keep state consistent between AppKit and SwiftUI?

Expose a single source of truth via ObservableObject/Combine publishers and update UI on the main thread; avoid duplicating mutable state.

How can I avoid layout issues when embedding SwiftUI in AppKit?

Contain NSHostingController in proper AppKit view controller hierarchies, set translatesAutoresizingMaskIntoConstraints to false, and use constraints or intrinsicContentSize adjustments for predictable sizing.