Interface DisplayOptions

interface DisplayOptions {
    alpha?:
        | boolean
        | "<number>"
        | "<percentage>"
        | {
            include?: boolean;
            type?: "<number>" | "<percentage>";
        };
    collapse?: boolean;
    commas?: boolean;
    coords?: string[];
    format?: string | SpaceFormat;
    inGamut?: boolean;
    precision?: number;
    space?: string | Space;
    supports?: ((property: string, value: string) => boolean);
}

Hierarchy (view full)

Properties

alpha? collapse? commas? coords? format? inGamut? precision? space? supports?

Properties

Optionalalpha

alpha?:
    | boolean
    | "<number>"
    | "<percentage>"
    | {
        include?: boolean;
        type?: "<number>" | "<percentage>";
    }

Alpha format

Optionalcollapse

collapse?: boolean

Whether or not to collapse colors to three- or four-digit hex when possible

Default

true

Optionalcommas

commas?: boolean

Force commas as a separator

Default

false

Optionalcoords

coords?: string[]

Coordinate format to override the default

Optionalformat

format?: string | SpaceFormat

Output format id. Defaults to the parsed format if available (and can serialize), or the color space default otherwise

Default

"default"

OptionalinGamut

inGamut?: boolean

Adjust coordinates to fit in gamut first

Default

false

Optionalprecision

precision?: number

Significant digits

Optionalspace

space?: string | Space

Color space to convert to if the color is not natively supported

Optionalsupports

supports?: ((property: string, value: string) => boolean)

Function used to test whether a serialization is supported, defaulting to CSS.supports. If absent (e.g. in Node), the color's own serialization is returned without a fallback.

Settings

Member Visibility

On This Page

Properties