Skip to main content

Interface: IToolboxConfig

A structure defining the configuration of the Toolbox.

Remarks​

For details, see the Toolbox https://customerscanvas.com/dev/editors/iframe-api/editor-configuration/toolbox.html|Toolbox topic.

Examples​

configuration = {
  widgets: {
    Toolbox: {
      buttons: `[{
                   translationKey: "Toolbox.TEXT",
                   translationKeyTitle: "Toolbox.TITLE_ADD_TEXT",
                   iconClass: "cc-icon-add-text",
                   buttons: ["Text", "BoundedText"]
           }]`,
    },
  },
};
"Toolbox": {
   "containerToolboxes": {
       "foil": {
           "buttons": [ "Text", "Image" ]
       },
       "texture": {
           "buttons": [ "Image" ]
       },
       "spot": {
           "buttons": [ "Rectangle", "Image" ]
       }
   }
}

Properties​

enabled?​

optional enabled?: boolean

If false, hides the Toolbox. The default value is false.

disabled?​

optional disabled?: boolean

Is obsoleted. Left for compatibility

buttons​

buttons: ButtonType[]

Defines configuration of Toolbox buttons.

containerToolboxes?​

optional containerToolboxes?: object

Allows for defining different toolboxes for different containers of spot colors and textures.

Index Signature​

[key: string]: IToolboxConfig

insertOnTop?​

optional insertOnTop?: boolean

If true, every new element will be added at the top of other layers. By default, this property is false, and when you add images, they appear below text elements.

Was this page helpful?