Interface IColorPickerConfigSection

A structure defining basic properties of Color picker sections.

Package: IframeApi

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

targets

An item property that you can specify a color for. The default value is ["All"].

Declaration

targets?: ColorPickerTarget[]

Property Value

Type	Description
ColorPickerTarget[]

translationKey

The section name. You can use either a string or an identifier of a string defined in the ~/Configuration/translations.json file.

Declaration

translationKey?: string

Property Value

Type	Description
string

type

The color section type, one of "NoColorSection", "RecentSection", "ThemeSection", or "PaletteSection".

Declaration

type: SectionType

Property Value

Type	Description
SectionType

viewType

The appearance of the section, either "Block" or "Line". The default value is "Block".

Declaration

viewType?: ColorPickerSectionViewType

Property Value

Type	Description
ColorPickerSectionViewType