Parse CSS3 gradient definitions and build an AST object.

Find a file

Rafael Caricio 59bb875120 Update README with more docs		2014-09-07 17:23:16 +02:00
lib	Update README with more docs	2014-09-07 17:23:16 +02:00
spec	Match radial declarations	2014-09-07 15:26:45 +02:00
.editorconfig	Add some configuration and organize project	2014-09-05 00:34:08 +02:00
.gitignore	Add some configuration and organize project	2014-09-05 00:34:08 +02:00
.npmignore	Add some configuration and organize project	2014-09-05 00:34:08 +02:00
.travis.yml	Add some configuration and organize project	2014-09-05 00:34:08 +02:00
.umd	Add some configuration and organize project	2014-09-05 00:34:08 +02:00
bower.json	Update	2014-09-06 20:08:22 +02:00
gruntfile.js	Add some configuration and organize project	2014-09-05 00:34:08 +02:00
index.js	Organize code	2014-09-06 19:46:07 +02:00
LICENSE	Initial commit	2014-09-04 17:16:48 +02:00
package.json	Organize code	2014-09-06 19:46:07 +02:00
README.md	Update README with more docs	2014-09-07 17:23:16 +02:00

README.md

Gradient Parser

About

Parse CSS3 gradient definition and returns AST object.

Examples

  var gradient = require('gradient-parser');
  var obj = gradient.parse('linear-gradient(30deg, #000, transparent)');
  console.log(JSON.stringify(obj, null, 2));

Results in:

[
  {
    "type": "linear-gradient",
    "orientation": {
      "type": "angular",
      "value": "30"
    },
    "colorStops": [
      {
        "type": "hex",
        "value": "000"
      },
      {
        "type": "literal",
        "value": "transparent"
      }
    ]
  }
]

Install Choices

bower install gradient-parser
download the zip

API

gradient.parse

Accepts the gradient definitions as it is declared in background-image and returns an AST object.

AST

Common properties

All nodes have the following properties.

type

String. The possible values are the ones listed in the Types section bellow.

Types

The available values of node.type are listed below, as well as the available properties of each node (other than the common properties listed above).

linear-gradient

orientation: Object possible types directional or angular.
colorStops: Array of color stops of type literal, hex, rgb, or rgba.

repeating-linear-gradient

orientation: Object possible types directional or angular.
colorStops: Array of color stops of type literal, hex, rgb, or rgba.

radial-gradient

orientation: Array or undefined. Array of possible types shape, default-radial.
colorStops: Array of color stops of type literal, hex, rgb, or rgba.

repeating-radial-gradient

orientation: Array or undefined. Array of possible types shape, default-radial.
colorStops: Array of color stops of type literal, hex, rgb, or rgba.

directional

value: String possible values left, top, bottom, right.

angular

value: Number integer number.

literal

value: String literal name of the color.

hex

value: String hex value.

rgb

value: Array of length 3 of Number's.

rgba

value: Array of length 4 or Number's.

shape

style: Object or undefined possible types extent-keyword, px, em, %, or positioning-keyword.
value: String possible values ellipse or circle.

default-radial

at: Object of attributes:
- x: Object possible types extent-keyword, px, em, %, or positioningKeyword.
- y: Object possible types extent-keyword, px, em, %, or positioningKeyword.

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.