ynie / colorwellkit

A versatile alternative to NSColorWell for Cocoa and ColorPicker for SwiftUI

ColorWellKit

A versatile alternative to NSColorWell for Cocoa and ColorPicker for SwiftUI.

ColorWellKit is designed to mimic the appearance and behavior of the color well designs introduced in macOS 13 Ventura, ideal for use in apps that are unable to target the latest SDK. While a central goal of ColorWellKit is to maintain a similar look and behave in a similar way to Apple's design, it is not intended to be an exact clone. There are a number of subtle design differences ranging from the way system colors are handled to the size of the drop shadow. In practice, there are very few notable differences:

Install

Add the following dependency to your Package.swift file:

.package(url: "https://github.com/jordanbaird/ColorWellKit", from: "0.2.0")

Usage

Read the full documentation here

SwiftUI

Create a ColorWellView and add it to your view hierarchy. There are a wide range of initializers and modifiers to choose from, allowing you to set the color well's color, label, and style.

import SwiftUI
import ColorWellKit

struct ContentView: View {
    @Binding var textColor: Color

    var body: some View {
        VStack {
            ColorWellView("Text Color", selection: $textColor)
                .colorWellStyle(.expanded)

            MyCustomTextEditor(textColor: $textColor)
        }
    }
}

Cocoa

Create a ColorWell using one of the available initializers, or use an IBOutlet to create a connection to a Storyboard or NIB file. Respond to color changes using your preferred design pattern.

import Cocoa
import ColorWellKit

class ViewController: NSViewController {
    @IBOutlet var colorWell: ColorWell!
    @IBOutlet var textEditor: NSTextView!

    override func viewDidLoad() {
        colorWell.style = .expanded
        if let textColor = textEditor.textColor {
            colorWell.color = textColor
        }
    }

    @IBAction func updateTextColor(sender: ColorWell) {
        textEditor.textColor = sender.color
    }
}

License

ColorWellKit is available under the MIT license.