NSUI

AppKit and UIKit without conditional compilation

There are small differences between otherwise-compatible classes in AppKit and UIKit and it drives everyone bananas. I was inspired by Nick Lockwood to make this into a package.

In general, the goal here is pure source compatibility. There are considerable platform-specific behavioral differences, and those are up to you to understand and account for.

When in doubt, UIKit wins. This keeps things familiar to the most people.

Other libraries you might like:

• ColorToolbox: AppKit/UIKit-compatible Color abstraction and utilities
• KeyCodes: AppKit Carbon key codes to UIKey-compatible enums
• Ligature: AppKit/UIKit-compatible UITextInputTokenizer and text system support

Integration

Swift Package Manager:

dependencies: [
    .package(url: "https://github.com/mattmassicotte/NSUI", from: "1.2.0")
]

Usage

// not only does this import the NSUI package, but it also will correctly make either AppKit or UIKit accessible depending on the build target platform.
import NSUI

// Make use of the cross-platform wrappers
let textView = NSUITextView()

There are cases where it is necessary to provide cross-platform wrappers around functions, accessors, or initializers. These account for type differences, including cases where value differ only in optionality.

// SwiftUI
Color(nsuiColor: NSUIColor)
Image(nsuiImage: NSUIImage)
NSUIControlActiveState

// AppKit/UIKit
NSUIFont.init(nsuiDescriptor:, size:)
NSUIFontDescriptor.nsuiWithSymbolicTraits(_:)
NSUITextView.nsuiLayoutManager
NSUITextView.nsuiSelectedRange

SwiftUI

NSUI also includes both NSUIViewRepresentable and NSUIViewControllerRepresentable to expose your custom view subclasses in SwiftUI.

Alternatives

• UXKit

Contributing and Collaboration

I would love to hear from you! Issues or pull requests work great. Both a Matrix space and Discord are available for live help, but I have a strong bias towards answering in the form of documentation. You can also find me on the web.

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.