Core API

gradiente exposes a small public API for parsing, checking, formatting, and transforming gradients.

parse

import { parse } from 'gradiente'

const gradient = parse('linear-gradient(to right, red, blue)')

parse() converts a gradient string into a gradient object.

Under the hood, gradiente tokenizes the string, builds ABI, and creates the correct gradient class.

isGradient

import { isGradient } from 'gradiente'

isGradient('linear-gradient(red, blue)') // true
isGradient('hello world') // false

Use it when you need a safe validation check.

format

import { format } from 'gradiente'

format('linear-gradient(to right, red, blue)')

format() parses and serializes the gradient back to a normalized string.

It also accepts an existing gradient object:

const gradient = parse('linear-gradient(red, blue)')

format(gradient)

transformTo

import { transformTo } from 'gradiente'

const css = transformTo('css', 'linear-gradient(to right, red, blue)')

transformTo() converts a gradient into a target format.

Examples of targets:

css
canvas
konva
pixi

Some targets may be planned or custom.

transformFrom

import { transformFrom } from 'gradiente'

const gradient = transformFrom('css', 'linear-gradient', {
  // target-specific input
})

transformFrom() creates a gradiente gradient object from another target format.

Mental model

string
  ↓ parse()
gradient object
  ↓ format()
string

gradient object
  ↓ transformTo()
target format

target format
  ↓ transformFrom()
gradient object

Summary

Use:

parse        → create gradient object
isGradient   → validate input safely
format       → normalize to string
transformTo  → export to target format
transformFrom → import from target format