Interface AdjustedColorPanelProps

interface AdjustedColorPanelProps {
    autoColor?: AdjustedColor;
    autoColorLabel?: NonNullable<ReactNode>;
    autoColorPosition?: AutoColorPosition;
    compareRGB?: boolean;
    darkMode?: boolean;
    disableAlpha?: boolean;
    initialPanelType?: ColorPanelType;
    onDone?: (() => void);
    onElementLoad?: (() => void);
    onEyeDropStart?: (() => void);
    onEyeDropStop?: (() => void);
    onPreviewColor?: ((color) => void);
    onPreviewColorImmediate?: ((color) => void);
    onSelectColor?: ((color, isCustom) => void);
    previewColor?: AdjustedColor;
    previewDebounceTime?: number;
    recentColors?: readonly AdjustedColor[] | (() => readonly AdjustedColor[]);
    schemeLookup?: SchemeColorLookup;
    selectedColor: AdjustedColor;
    width?: number;
}

Hierarchy

  • HTMLAttributes<HTMLElement>
    • AdjustedColorPanelProps

Properties

autoColor? autoColorLabel? autoColorPosition? compareRGB? darkMode? disableAlpha? initialPanelType? onDone? onElementLoad? onEyeDropStart? onEyeDropStop? onPreviewColor? onPreviewColorImmediate? onSelectColor? previewColor? previewDebounceTime? recentColors? schemeLookup? selectedColor width?

Properties

Optional autoColor

autoColor?: AdjustedColor

If autoColor is set then a special Swatch is created that will use this color. When it is selected or previewed the color passed will be null any consumer will then know to use the auto color

Optional autoColorLabel

autoColorLabel?: NonNullable<ReactNode>

If autoColor is specified then a label will be shown. This is ignored if autoColor is not specified.

Default Value

Automatic

Optional autoColorPosition

autoColorPosition?: AutoColorPosition

If autoColor is specified then a label will be shown. This is ignored if autoColor is not specified.

Default Value

AutoColorPosition.Start

Optional compareRGB

compareRGB?: boolean

Determines if Adjustable colors with similar RGB values are considered the same.

Default Value

false

Optional darkMode

darkMode?: boolean

Optional disableAlpha

disableAlpha?: boolean

Defaults to false

Optional initialPanelType

initialPanelType?: ColorPanelType

If not specified or null then this will be determined based on whether the selected color is available in the presets (not include recent)

Optional onDone

onDone?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onElementLoad

onElementLoad?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onEyeDropStart

onEyeDropStart?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onEyeDropStop

onEyeDropStop?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onPreviewColor

onPreviewColor?: ((color) => void)

Type declaration

Optional onPreviewColorImmediate

onPreviewColorImmediate?: ((color) => void)

Type declaration

Optional onSelectColor

onSelectColor?: ((color, isCustom) => void)

Type declaration

    • (color, isCustom): void

    • Parameters

      Returns void

Optional previewColor

previewColor?: AdjustedColor

Optional previewDebounceTime

previewDebounceTime?: number

Optional recentColors

recentColors?: readonly AdjustedColor[] | (() => readonly AdjustedColor[])

Type declaration

Optional schemeLookup

schemeLookup?: SchemeColorLookup

Required to generate theme palettes. If not specified then DocTheme colors are used

selectedColor

selectedColor: AdjustedColor

Optional width

width?: number

Settings

Member Visibility

Theme

On This Page

autoColorautoColorLabelautoColorPositioncompareRGBdarkModedisableAlphainitialPanelTypeonDoneonElementLoadonEyeDropStartonEyeDropStoponPreviewColoronPreviewColorImmediateonSelectColorpreviewColorpreviewDebounceTimerecentColorsschemeLookupselectedColorwidth