ColorsKit

Pragmatic color utilities for SwiftUI and UIKit.

ColorsKit helps you parse hex colors, check accessibility contrast, generate palettes, build gradients, and simulate color‑vision deficiencies — all with a tiny, focused API that feels at home in Swift.

Installation (SPM)

Add the package to Xcode or your Package.swift using the public repo and a tag.

• URL: https://github.com/ckdash-git/ColorsKit.git
• Minimum platforms: iOS 13+, macOS 12+, tvOS 13+, watchOS 6+

// Package.swift
.dependencies: [
    .package(url: "https://github.com/ckdash-git/ColorsKit.git", from: "0.1.2")
]
.targets: [
    .target(
        name: "App",
        dependencies: [
            .product(name: "ColorsKit", package: "ColorsKit")
        ]
    )
]

In Xcode: File → Add Packages… → paste the URL → add the ColorsKit product.

Installation (CocoaPods)

Add to your Podfile (iOS example):

platform :ios, '13.0'
use_frameworks!

target 'App' do
  pod 'ColorsKit', '~> 0.1'
end

Then run pod install and import the module:

import ColorsKit

💖 Support This Project

ColorsKit is an open source project that helps developers build better color experiences in their apps. Your support helps maintain and improve this library for the entire Swift community.

Why Sponsor?

• 🚀 Faster Development: Sponsorship enables dedicated time for new features, bug fixes, and performance improvements
• 📚 Better Documentation: More comprehensive guides, examples, and API documentation
• 🔧 Enhanced Tooling: Additional utilities, CLI tools, and developer experience improvements
• 🌟 Community Growth: Support for community contributions, issue triage, and user support

Sponsorship Options

🎯 GitHub Sponsors

• Monthly Support: Recurring sponsorship with tiered benefits
• One-time Contributions: Flexible support options
• Sponsor Recognition: Listed in project documentation and releases
• Early Access: Preview new features and provide feedback

☕ Buy Me a Coffee

• Quick Support: Simple one-time or recurring donations
• Personal Messages: Send encouragement and feature requests
• Community Building: Join a supportive community of users
• Flexible Amounts: Choose what works for your budget

Sponsor Benefits

Tier	Monthly	Benefits
☕ Coffee	$5	Sponsor badge, early access to releases
🌟 Supporter	$15	Above + priority issue responses
🚀 Advocate	$50	Above + feature request priority
💎 Champion	$100+	Above + direct consultation access

Current Sponsors

Thank you to all our amazing sponsors! Your support makes ColorsKit possible.

Become our first sponsor and see your name here!

---

Quick Start

import ColorsKit

// Hex → RGBA
let fg = try HexColorFormatter.parse("#1A73E8")
let bg = try HexColorFormatter.parse("#FFFFFF")

// Contrast ratio + WCAG
let ratio = ColorMath.contrastRatio(fg, bg)
let isAA = Accessibility.meets(.AA, foreground: fg, background: bg)
let isAAA = Accessibility.meets(.AAA, foreground: fg, background: bg)

// Palette around a base color
let palette = PaletteGenerator.generate(from: "#1A73E8", steps: 6, range: 0.25)

// Simulate color‑vision deficiency
let protanopia = ColorBlindnessSimulator.simulate(.protanopia, rgba: fg)

SwiftUI

import SwiftUI
import ColorsKit

// Create Color from hex
let primary = Color(hex: "#0A84FF")

// Dynamic light/dark Color (bridges via UIKit on iOS)
let dynamic = Color.dynamic(lightHex: "#FFFFFF", darkHex: "#000000")

// LinearGradient from hex list
let gradient = SwiftUIGradientBuilder.linear(hexColors: ["#0A84FF", "#5E5CE6"]) 

UIKit

import UIKit
import ColorsKit

let primary = UIColor(hex: "#0A84FF")
let dynamic = UIColor.dynamic(lightHex: "#FFFFFF", darkHex: "#000000")

Example CLI

A tiny command‑line demo lives in Example/ConsumerSample/.

• Run: cd Example/ConsumerSample && swift run
• Shows: hex parsing, contrast ratio, palette generation, and color‑blindness simulation.

Modules at a Glance

• ColorCore: RGBA, HexColorFormatter, ColorMath, Accessibility, Theme, ThemeManager
• ColorUtilities: PaletteGenerator, AccessibilityUtils, ColorBlindnessSimulator
• ColorExtensions: SwiftUI/UIColor helpers, gradients
• ColorPalettes: Predefined themes and palette helpers

Platform Notes

• Color.dynamic bridges to Color(uiColor:) on iOS/tvOS.
• On iOS/tvOS < 15, Color.dynamic falls back to the light variant.
• CocoaPods support: iOS and macOS in 0.1.0; tvOS/watchOS coming in a follow‑up release.

Versioning

This repo follows semantic versioning. Start with 0.1.0 and evolve via tags.

License & Trademarks

Apache-2.0. See LICENSE and NOTICE. "ColorsKit" is a trademark — see TRADEMARKS.md.

Community: See CONTRIBUTING.md (DCO) and CODE_OF_CONDUCT.md.