Interface IColorPickerConfig

A structure defining the Color picker.

Package: @aurigma/design-editor-iframe

Remarks

See the Color picker topic for more details.

Examples

configuration = {
    widgets: {
        ColorPicker: {
            colorSpace: "rgb",
            sections: [
              {
                type: "NoColorSection",
                targets: [ "Fill", "Border", "Background" ]
              },
              {
                type: "RecentSection",
                translationKey: "ColorPicker.RECENT_SECTION_NAME"
              },
              {
                type: "PaletteSection",
                translationKey: "Swatches",
                viewType: "Line",
                palette: [["rgb(0, 0, 0)","rgb(255, 255, 255)"],
                          ["rgb(255, 0, 0)","rgb(255, 255, 0)","rgb(0, 255, 0)","rgb(0, 255, 255)","rgb(0, 0, 255)","rgb(255, 0, 255)"]]
              }
            ]
        }
    }
};

Properties

colorSpace

Defines the color space which the user can select a swatch from. The default value is "rgb".

Declaration

colorSpace?: ColorSpace.ColorSpaceType;

Property Value

Type	Description
ColorSpaceType	Defines the color space which the user can select a swatch from. The default value is "rgb".

paletteHintsEnabled

If true, displays the hints. The default value is false.

Declaration

paletteHintsEnabled?: boolean;

Property Value

Type	Description
boolean	If true, displays the hints. The default value is false.

sectionCollapseEnabled

If true, allows users to collapse the sections of predefined palettes when they click headers of these sections in the Color picker. The default value is false.

Declaration

sectionCollapseEnabled?: boolean;

Property Value

Type	Description
boolean	If true, allows users to collapse the sections of predefined palettes when they click headers of these sections in the Color picker. The default value is false.

sections

A set of predefined palettes.

Declaration

sections?: IColorPickerConfigSection[];

Property Value

Type	Description
IColorPickerConfigSection[]	A set of predefined palettes.

showPaletteOnly

If true, shows the predefined palettes and hides the color field in the Color picker. If false, shows both the predefined palettes and the field. The default value is false.

Declaration

showPaletteOnly?: boolean;

Property Value

Type	Description
boolean	If true, shows the predefined palettes and hides the color field in the Color picker. If false, shows both the predefined palettes and the field. The default value is false.