rafaelcaricio/gradient-parser
1
0
Fork 0
Code Issues 9 Pull requests Projects Releases Wiki Activity

Start writing doc

Browse source
This commit is contained in:
Rafael Caricio 2014-09-07 16:13:02 +02:00
parent 930e8aefe9
commit 62575d110c
1 changed files with 25 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -44,7 +44,31 @@ Results in:
### gradient.parse
Accepts the gradient definitions as it is declared in the `background-image` and returns an AST `object`.
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`.
## License