Project

shade

0.01
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Using CIE L*a*b* and kdtrees, take a color (from LESS, SCSS, or other inputs) and find the nearest shade of color from a given palette
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Shade

Rubygem to find the closest color from a given palette.

Build Status Gem Version Code Climate Dependency Status

This was created to help migrate Twitter's Advertising webapp from more than a thousand different colors into a small well-considered palette of colors.

Both the CIE76 color difference algorithm, via Shade::Palette.nearest_value, and the CIE94 color difference algorithm, via Shade::Palette.nearest_value_cie94 implementations are available.

The CIE94 implementation is slower, but may have better results, as saturation perception is better accounted for in that algorithm.

Installation

Add this line to your application's Gemfile:

gem 'shade'

And then execute:

$ bundle

Or install it yourself as:

$ gem install shade

Usage

p = Shade::Palette.new do |p|
  p.add('#663399', 'deepPurple')
  p.add('#5BA636', 'darkGreen')
end

p.nearest_value('green')
=> #<struct Shade::Palette::Value name="#5BA636", css_color="darkGreen">

Contributing

  1. Fork it ( https://github.com/mceachen/shade/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request