mcpField
A
appkit-interop

appkit-interop

github.com/openaiDevelopment7.6k62 installsUpdated 3w ago
Repository

About appkit-interop

A skill for SwiftUI developers who need native macOS behavior that SwiftUI alone does not cover. It selects a small AppKit bridge—view, view controller, or app-level hooks—and defines state ownership and lifecycle boundaries.

Key features

  1. 01Choose the smallest suitable bridge
  2. 02Wrap AppKit views with Representable
  3. 03Handle windows, menus, and responder chains
  4. 04Define SwiftUI and AppKit state boundaries
  5. 05Review coordinator and lifecycle assumptions

Use cases

  1. 01Add a specific AppKit control to SwiftUI
  2. 02Implement window or panel behavior
  3. 03Handle menu validation and first responder
  4. 04Add drag-and-drop or file panel support

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/openai/plugins --skill appkit-interop

After installing, type/appkit-interopin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

agents/
openai.yaml
references/
drag-drop-pasteboard.md
representables.md
responder-menus.md
window-panels.md

Details

From the project README

AppKit Interop

Quick Start

Use this skill when SwiftUI is close but not quite enough for native macOS behavior. Keep the bridge as small and explicit as possible. SwiftUI should usually remain the source of truth, while AppKit handles the imperative edge.

Choose The Smallest Bridge

  • Use pure SwiftUI when the required behavior already exists in scenes, toolbars, commands, inspectors, or standard controls.
  • Use NSViewRepresentable when you need a specific AppKit view with lightweight lifecycle needs.
  • Use NSViewControllerRepresentable when you need controller lifecycle, delegation, or presentation coordination.
  • Use direct AppKit window or app hooks when you need NSWindow, responder-chain, menu validation, panels, or app-level behavior.

Workflow

  1. Name the capability gap precisely.

    • Window behavior
    • Text system behavior
    • Menu validation
    • Drag and drop
    • File open/save panels
    • First responder control

  2. Pick the smallest boundary that solves it.

    • Avoid porting a whole screen to AppKit when one wrapped control or coordinator would do.

  3. Keep ownership explicit.

    • SwiftUI owns value state, selection, and observable models.
    • AppKit objects stay inside the representable, coordinator, or bridge object.

  4. Expose a narrow interface back to SwiftUI.

    • Bindings for editable state
    • Small callbacks for events
    • Focused bridge services only when necessary

  5. Validate lifecycle assumptions.

    • SwiftUI may recreate representables.
    • Coordinators exist to hold delegate and target-action glue, not as a second app architecture.

References

  • references/representables.md: choosing between view and view-controller wrappers, plus coordinator patterns.
  • references/window-panels.md: window access, utility windows, and open/save panels.
  • references/responder-menus.md: first responder, command routing, and menu validation.
  • references/drag-drop-pasteboard.md: pasteboard, file URLs, and desktop drag/drop edges.

Guardrails

  • Do not duplicate the source of truth between SwiftUI and AppKit.
  • Do not let Coordinator become an unstructured dumping ground.
  • Do not store long-lived NSView or NSWindow instances globally without a strong ownership reason.
  • Prefer a tiny tested bridge over rewriting the feature in raw AppKit.
  • If a pattern can remain entirely in swiftui-patterns, keep it there.

Output Expectations

Provide:

  • the exact SwiftUI limitation being crossed
  • the smallest recommended bridge type
  • the data-flow boundary between SwiftUI and AppKit
  • the lifecycle or validation risks to watch

Comments

Markdown supported