Blame view

node_modules/colormin/README.md 1.31 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
  # colormin [![Build Status](https://travis-ci.org/ben-eb/colormin.svg?branch=master)][ci] [![NPM version](https://badge.fury.io/js/colormin.svg)][npm] [![Dependency Status](https://gemnasium.com/ben-eb/colormin.svg)][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