WFColorCode 2.1.3

WFColorCode 2.1.3

TestsTested
LangLanguage SwiftSwift
License MIT
ReleasedLast Release Mar 2018
SPMSupports SPM

Maintained by 1024jp, 1024jp.



  • By
  • 1024jp

WFColorCode

Build Status codecov.io Carthage compatible SPM compatible CocoaPods version CocoaPods platform

WFColorCode is a NSColor extension that allows creating NSColor instance from a CSS color code string, or color code string from a NSColor instance. It also adds the ability to handle HSL color space.

  • Requirements: OS X 10.9 or later
  • ARC: ARC enabled

Usage

WFColorCode supports the following color code styles.

/// color code type
enum WFColorCodeType: Int {
    case invalid    // nil
    case hex        // #ffffff
    case shortHex   // #fff
    case cssRGB     // rgb(255,255,255)
    case cssRGBa    // rgba(255,255,255,1)
    case cssHSL     // hsl(0,0%,100%)
    case cssHSLa    // hsla(0,0%,100%,1)
    case cssKeyword // White
};

Example

Import ColorCode to use.

import ColorCode

// create NSColor instance from HSLa color code
var colorCodeType: ColorCodeType = .invalid
let whiteColor = NSColor(colorCode: "hsla(0,0%,100%,0.5)", type: &colorCodeType)
let hex: String = whiteColor.colorCode(type: .hex)  // => "#ffffff"

// create NSColor instance from HSLa values
let color = NSColor(deviceHue:0.1, saturation:0.2, lightness:0.3, alpha:1.0)

// create NSColor instance from a CSS3 keyword
let ivoryColor = NSColor(colorCode: "ivory", codeType:nil)

// get HSL values from NSColor instance
var hue: CGFloat = 0
var saturation: CGFloat = 0
var lightness: CGFloat = 0
var alpha: CGFloat = 0
color.getHue(hue: &hue, saturation: &saturation, lightness: &lightness, alpha: &alpha)

Installation

Framework via Carthage

WFColorCode is Carthage compatible. Add the following line to your Cartfile.

github "1024jp/WFColorCode" ~> 2.0.0

Framework via Cocoapods

WFColorCode is also available via CocoaPods. You can easily install it adding the following line to your Podfile:

pod "WFColorCode"

Swift Package Manager

WFColorCode is also Swift Package Manager compatible.

Source files

If you use neither CocoaPods nor Carthage, place NSColor+ColorCode.swift and NSColor+HSL.swift in Classes/ directory somewhere in your project.

License

© 2014-2018 1024jp.

The source code is distributed under the terms of the MIT License. See the bundled "LICENSE" for details.