JSPM

  • Created
  • Published
  • Downloads 15
  • Score
    100M100P100Q59470F
  • License MIT

A gradient picker component

Package Exports

  • @ldrender/gradient-picker
  • @ldrender/gradient-picker/dist/gradient-picker.css

Readme

Gradient Picker

A website that allows you to create your own gradient

image

Installation

  npm install @ldrender/gradient-picker

Usage

import GradientPicker from '@ldrender/gradient-picker';
import '@ldrender/gradient-picker/dist/gradient-picker.css';

const gradientPicker = new GradientPicker({
  el: document.querySelector('#gradient-picker'),
  onChange: (gradient) => {
    console.log(gradient);
  }
});

API Documentation

GradientPicker Instance

new GradientPicker(options: GradientPickerOptions): GradientPicker

Create a new instance of GradientPicker.

GradientPickerOptions

Name Type Default Value Description
el HTMLElement The element to render the gradient picker
stops? GradientStop[] The initial stops of the gradient
directionType? string('select' | 'percent') 'select' The type of gradient

GradientStop

Name Type Description
color string The color of the stop
position number The position of the stop

GradientPicker Methods

getGradient(): object

Exemple :

{
    "type": "linear",
    "direction": "to right",
    "stops": [
        {
        "color": "#ff0000",
        "position": 0
        },
        {
            "color": "#00ff00",
            "position": 1
        }
    ]
}
getGradientString(): string

Exemple :

linear-gradient(to right, #ff0000 0%, #00ff00 100%)
addColorStop(color: string, position: number): void

Add a color stop to the gradient.