UIImageColors

You can install UIImageColors using Manual, CocoaPods, or Carthage.

Manual

Copy UIImageColors.swift directly into your project.

CocoaPods

Add the following to your Podfile:

pod 'UIImageColors'

Carthage

Add the following to your Cartfile:

gitub "jathu/UIImageColors"

Use getColors() to extract dominant and prominent colors from a UIImage (iOS/tvOS) or NSImage (macOS). You can use the synchronous method for immediate results or the asynchronous method with a completion handler to avoid blocking the main thread.

By default, the extraction uses high quality.

// Asynchronous example
let image = UIImage(named: "yeezus.png")

image.getColors { colors in
  backgroundView.backgroundColor = colors.background
  mainLabel.textColor = colors.primary
  secondaryLabel.textColor = colors.secondary
  detailLabel.textColor = colors.detail
}

// Synchronous example
let colors = UIImage(named: "yeezus.png").getColors()

backgroundView.backgroundColor = colors.background
mainLabel.textColor = colors.primary
secondaryLabel.textColor = colors.secondary
detailLabel.textColor = colors.detail

The UIImageColorsQuality enum controls the downscaling of the original image to balance performance and color accuracy. The default quality is .high.

Qualities:

• .lowest: 50px scale. Fastest performance, lowest quality.
• .low: 100px scale.
• .high: 250px scale. Default.
• .highest: No downscaling. Best quality, but very slow.

public enum UIImageColorsQuality: CGFloat {
    case lowest = 50 // 50px
    case low = 100 // 100px
    case high = 250 // 250px
    case highest = 0 // No scale
}

The following methods are available on UIImage and NSImage instances to retrieve UIImageColors:

• getColors() -> UIImageColors?
• getColors(quality: ImageColorsQuality) -> UIImageColors?
• getColors(_ completion: (UIImageColors?) -> Void) -> Void
• getColors(quality: UIImageColorsQuality, _ completion: (UIImageColors?) -> Void) -> Void

The UIImageColors struct contains four color properties used to theme UI elements based on the image content. On iOS/tvOS these are UIColor, and on macOS these are NSColor.

Properties:

• background: The background color.
• primary: The primary color.
• secondary: The secondary color.
• detail: The detail color.