https://github.com/projectwallace/color-sorter

Sort CSS colors by hue, then by saturation
https://github.com/projectwallace/color-sorter

analytics color-sorting colors complexity css projectwallace stats wallace

Last synced: about 2 months ago
JSON representation

Sort CSS colors by hue, then by saturation

• Host: GitHub
• URL: https://github.com/projectwallace/color-sorter
• Owner: projectwallace
• License: mit
• Created: 2018-07-23T13:30:37.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-05T08:14:53.000Z (4 months ago)
• Last Synced: 2024-05-17T13:23:13.747Z (4 months ago)
• Topics: analytics, color-sorting, colors, complexity, css, projectwallace, stats, wallace
• Language: JavaScript
• Homepage:
• Size: 924 KB
• Stars: 66
• Watchers: 3
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license

Awesome Lists containing this project

• my-awesome-list - color-sorter

README

        
# color-sorter

![Color sorter](https://repository-images.githubusercontent.com/142018423/f0333800-be49-11ea-8033-0e3df5daf1ab)

Sort CSS colors by hue, then by saturation. Black-grey-white colors (colors with

0% saturation) are shifted to the end. Fully transparent colors are placed at

the _very_ end.

This sorting algorithm is very opinionated and might not fit _your_ needs!

## Usage

```js

import { sortFn, sort } from "color-sorter";

var colors = ["#000", "red", "hsl(0, 10%, 60%)"];

var sorted = colors.sort(sortFn);

// Or:

// sorted = sort(colors)

// => sorted:

// [

//  'red',

//  'hsl(0, 10%, 60%)',

//  '#000'

// ]

```

Want to try it out?

- [Stackblitz example with ESM](https://stackblitz.com/edit/color-sorter-example-esm?file=index.js&view=editor)

- [Stackblitz example with CommonJS](https://stackblitz.com/edit/color-sorter-example-cjs?file=index.js&view=editor)

## Examples

These examples can be seen on [Project Wallace](https://projectwallace.com)

where this package is used for sorting the colors.

### CSS-Tricks

![CSS Tricks color sort example](/examples/css-tricks.png)

### Smashing Magazine

![Smashing Magazine color sort example](/examples/smashing-magazine.png)

### Bootstrap

![Bootstrap color sort example](/examples/bootstrap.png)

### Zurb Foundation

![Zurb Foundation color sort example](/examples/foundation.png)

### Project Wallace

![Project Wallace color sort example](/examples/project-wallace.png)

## Related projects

- [CSS Analyzer](https://github.com/projectwallace/css-analyzer) - Generate

  analysis for a string of CSS

- [Wallace](https://github.com/projectwallace/wallace-cli) - CLI tool for

  @projectwallace/css-analyzer

- [Constyble](https://github.com/projectwallace/constyble) - A CSS complexity linter, based on css-analyzer. Don't let your CSS grow beyond the thresholds that you provide.

## License

MIT © Bart Veneman