The project is in a healthy, maintained state
A collection of colour swatches from various palettes and their corresponding hex value.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

 Project Readme

ColorSwatchCollection

Find a colour swatch from various collections.

ColorSwatchCollection is a ruby gem package for use in ruby or other projects that provides colour swatches with their name and hex code from various collections. You can find colour swatches by providing either the name or hex code you want to search against. You can also query collection colour lists directly.

Lists

The colour collections:

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add color_swatch_collection

If bundler is not being used to manage dependencies, install the gem by executing:

gem install color_swatch_collection

Usage

ColorSwatchCollection.list_collections
=> ['basic', 'html', 'ntc', 'pantone', 'roygbiv', 'x11']
ColorSwatchCollection.get_from_hex('#FDBCB4')
=> { name: 'melon', hex: '#FDBCB4', collection: 'pantone' }
ColorSwatchCollection.get_from_name('navajo white')
=> { name: 'navajowhite', hex: '#FFDEAD', collection: 'html' }
ColorSwatchCollection.get_colours
=> [
=>   { collection: 'basic', hex: '#000000', name: 'black' },
=>   { collection: 'basic', hex: '#0000FF', name: 'blue' },
=>   .
=>   .
=>   .
=> ]

pick

This parameter allows you to filter names from the dedicated lists for faster computation. It can be used for get_from_hex, get_from_name, or get_colours.

ColorSwatchCollection.get_from_hex('#00FF00', pick: ['html', 'pantone'])
ColorSwatchCollection.get_from_name('blue', pick: ['x11'])
ColorSwatchCollection.get_colours(pick: ['basic'])

omit

The opposite of options.pick. It can be used for get_from_hex, get_from_name, or get_colours.

ColorSwatchCollection.get_from_hex('#00FF00', omit: ['html', 'pantone'])
ColorSwatchCollection.get_from_name('blue', omit: ['ntc'])
ColorSwatchCollection.get_colours(omit: ['ntc', 'basic'])

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/louiswdavis/color_swatch_collection. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the ColorSwatchCollection project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.