@skchr/color
    Preparing search index...

    Type Alias DistributionOptions

    DistributionOptions: Pick<InterpolatorOptions, "hueFixup"> & {
        colorspace?: Colorspaces;
        excludeAchromatic?: boolean;
        excludeSelf?: boolean;
        extremum?: "min" | "max" | "mean";
        factor?: Factor[];
        token?: TokenOptions;
    }

    Override for factor distributed palettes.

    Type declaration

    • Optionalcolorspace?: Colorspaces

      The colorspace to distribute the specified factor in. Defaults to lch when the passed in mode has no 'chroma' | 'hue' | 'lightness' channel

    • OptionalexcludeAchromatic?: boolean

      Exclude grayscale colors from the distribution operation. Default is false

    • OptionalexcludeSelf?: boolean

      Exclude the color with the specified extremum from the distribution operation. Default is false

    • Optionalextremum?: "min" | "max" | "mean"

      The extreme end for the factor we wish to distribute. If mean is picked, it will map the average value of that factor in the passed in collection.

    • Optionalfactor?: Factor[]

      The factor(s) to distribute amongst each color token in the passed in collection.

    • Optionaltoken?: TokenOptions

      Specify the parsing behaviour and change output type of the ColorToken.

    Settings

    Member Visibility