62 lines
1.3 KiB
Markdown
62 lines
1.3 KiB
Markdown
|
# colormin [][ci] [][npm] [][deps]
|
||
|
|
|
||
|
|
> Turn a CSS color into its smallest representation.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
With [npm](https://npmjs.org/package/colormin) do:
|
||
|
|
|
||
|
|
```
|
||
|
|
npm install colormin --save
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
```js
|
||
|
|
var colormin = require('colormin');
|
||
|
|
console.log(colormin('rgba(255, 0, 0, 1)'));
|
||
|
|
|
||
|
|
// => 'red'
|
||
|
|
```
|
||
|
|
|
||
|
|
colormin works for rgb, rgba, hsl, hsla, hex & css color keywords. See more
|
||
|
|
example output in the [tests](src/__tests__/index.js). Note that colormin does
|
||
|
|
not convert invalid CSS colors, as it is not a color validator.
|
||
|
|
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### colormin(color, [options])
|
||
|
|
|
||
|
|
#### color
|
||
|
|
|
||
|
|
Type: `string`
|
||
|
|
|
||
|
|
The color to minify.
|
||
|
|
|
||
|
|
#### options
|
||
|
|
|
||
|
|
##### legacy
|
||
|
|
|
||
|
|
Type: `boolean`
|
||
|
|
Default: `false`
|
||
|
|
|
||
|
|
Set this to `true` to enable IE < 10 compatibility; the browser chokes on the
|
||
|
|
`transparent` keyword, so in this mode the conversion from `rgba(0,0,0,0)`
|
||
|
|
is turned off.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Pull requests are welcome. If you add functionality, then please add unit tests
|
||
|
|
to cover it.
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT © [Ben Briggs](http://beneb.info)
|
||
|
|
|
||
|
|
[ci]: https://travis-ci.org/ben-eb/colormin
|
||
|
|
[deps]: https://gemnasium.com/ben-eb/colormin
|
||
|
|
[npm]: http://badge.fury.io/js/colormin
|