Methods
get(colors, options) → {string}
Parameters:
| Name | Type | Description |
|---|---|---|
colors |
Colors | |
options |
Options |
Returns:
Returns single css gradient string
- Type
- string
Type Definitions
BaseOptions
Base configuration object
Type:
- object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
interpolation |
string | 'linear' or 'bezier' | |
mode |
string |
<optional> |
'none', 'lch', 'lab', 'rgb', 'hsv', 'hsl', 'hsi', or 'hcl' (only for linear interpolation) |
samples |
number | number of output colors | |
lightnessCorrection |
boolean | lightness correction applier |
Colors
colors input
Type:
- Array.<Array.<number>> | Array.<string>
CssOptions
Css configuration object
Type:
- object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
type |
string | 'linear' or 'radial' | |
angle |
number |
<optional> |
linear gradient's angle value |
left |
number |
<optional> |
radial gradient's position on the x axis |
top |
number |
<optional> |
radial gradient's position on the y axis |
shape |
string |
<optional> |
radial gradient's shape: 'ellipse' or 'circle' (mandatory for radial gradient) |
extent |
string |
<optional> |
radial gradient's extent keyword |
Options
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
base |
BaseOptions | |
css |
CssOptions |