Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jordanbaird/colorwell
A versatile alternative to NSColorWell for Cocoa and ColorPicker for SwiftUI.
https://github.com/jordanbaird/colorwell
apple color color-picker color-well colorpicker colorwell macos nscolorwell swift swift-package-manager swiftui
Last synced: 3 months ago
JSON representation
A versatile alternative to NSColorWell for Cocoa and ColorPicker for SwiftUI.
- Host: GitHub
- URL: https://github.com/jordanbaird/colorwell
- Owner: jordanbaird
- License: mit
- Archived: true
- Created: 2022-10-11T03:03:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-07T21:21:25.000Z (about 1 year ago)
- Last Synced: 2024-09-24T21:40:52.729Z (3 months ago)
- Topics: apple, color, color-picker, color-well, colorpicker, colorwell, macos, nscolorwell, swift, swift-package-manager, swiftui
- Language: Swift
- Homepage:
- Size: 2.76 MB
- Stars: 20
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Notice
Due to a number of design problems and increasing repository bloat, this package has been deprecated and replaced, and this repository will be archived. Please use its successor [ColorWellKit](https://github.com/jordanbaird/ColorWellKit) instead.
# ColorWell
[![Continuous Integration][ci-badge]](https://github.com/jordanbaird/ColorWell/actions/workflows/test.yml)
[![Release][release-badge]](https://github.com/jordanbaird/ColorWell/releases/latest)
[![Swift Versions][versions-badge]](https://swiftpackageindex.com/jordanbaird/ColorWell)
[![Docs][docs-badge]](https://swiftpackageindex.com/jordanbaird/ColorWell/documentation)
[![License][license-badge]](LICENSE)
A versatile alternative to `NSColorWell` for Cocoa and `ColorPicker` for SwiftUI.
ColorWell is designed to mimic the appearance and behavior of the new color well design in macOS 13 Ventura, for those who want to use the new design on older operating systems. While the goal is for ColorWell to look and behave in a similar way to Apple's design, it is not 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. However, in practice, there are very few notable differences:
## Install
Add the following dependency to your `Package.swift` file:
```swift
.package(url: "https://github.com/jordanbaird/ColorWell", from: "0.2.2")
```
## Usage
[Read the full documentation here](https://swiftpackageindex.com/jordanbaird/ColorWell/documentation)
### SwiftUI
Create a `ColorWellView` and add it to your view hierarchy. There are a wide range of initializers, as well as several modifiers to choose from, allowing you to set the color well's color, label, and action.
```swift
import SwiftUI
import ColorWell
struct ContentView: View {
@Binding var fontColor: Color
var body: some View {
VStack {
ColorWellView("Font Color", color: fontColor, action: updateFontColor)
.colorWellStyle(.expanded)
MyCustomTextEditor(fontColor: $fontColor)
}
}
private func updateFontColor(_ color: Color) {
fontColor = color
}
}
```
### Cocoa
Create a `ColorWell` using one of the available initializers. Observe color changes using the `onColorChange(perform:)` method.
```swift
import Cocoa
import ColorWell
class ContentViewController: NSViewController {
let colorWell: ColorWell
let textEditor: MyCustomNSTextEditor
init(fontColor: NSColor) {
self.colorWell = ColorWell(color: fontColor)
self.textEditor = MyCustomNSTextEditor(fontColor: fontColor)
super.init(nibName: "ContentView", bundle: Bundle(for: Self.self))
// Set the style
colorWell.style = .expanded
// Add a change handler
colorWell.onColorChange { newColor in
self.textEditor.fontColor = newColor
}
}
override func viewDidLoad() {
super.viewDidLoad()
view.addSubview(colorWell)
view.addSubview(textEditor)
// Layout the views, perform setup work, etc.
}
}
```
## License
ColorWell is available under the [MIT license](LICENSE).
[ci-badge]: https://img.shields.io/github/actions/workflow/status/jordanbaird/ColorWell/test.yml?branch=main&style=flat-square
[release-badge]: https://img.shields.io/github/v/release/jordanbaird/ColorWell?style=flat-square
[versions-badge]: https://img.shields.io/badge/dynamic/json?color=F05138&label=Swift&query=%24.message&url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fjordanbaird%2FColorWell%2Fbadge%3Ftype%3Dswift-versions&style=flat-square
[docs-badge]: https://img.shields.io/static/v1?label=%20&message=documentation&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAEsSURBVHgB7dntDYIwEAbgV+MAuoEj6AaO4AiO4AayAbqBbuAGjoIbwAbnHT8MMTH9uEJrvCch/FB7vEh7EABjjBMRnXhrKY1GxsNUuFhN45gmBKU783lCDKtBiYeoUoeYI79KE6KEACI6RCkBRFSIkgKI4BClBRBBIUoMILxDlBpASIgjtBL3gR2FaV1jzjyKvg98xqDEw615t3Z87eFbc/IAPkJqljwHvFiA3CxAbhaAdI+cNZTUfWD4edQBOMacog9cEE/z25514twsQG4/H2ABJZ5vG97tEefKc/QJhRR9oIH7AeWbjodchdYcSnEJLRGvg5L6EmJb3g6Ic4eSNbLcLEBuf9HIZKnrl0rtvX8E5zLr8w+o79kVbkiBT/yZxn3Z90lqVTDGOL0AoGWIIaQgyakAAAAASUVORK5CYII=&color=informational&labelColor=gray&style=flat-square
[license-badge]: https://img.shields.io/github/license/jordanbaird/ColorWell?style=flat-square