Interface IToolboxConfig

A structure defining the configuration of the Toolbox.

Package: @aurigma/design-editor-iframe

Remarks

For details, see the Toolbox topic.

Examples

configuration = {
   widgets: {
       Toolbox: {
           buttons: [{
                   translationKey: "Toolbox.TEXT",
                   translationKeyTitle: "Toolbox.TITLE_ADD_TEXT",
                   iconClass: "cc-icon-add-text",
                   buttons: ["Text", "BoundedText"]
           }]
       }
   }
};

This is how you can define different toolboxes for different containers.

"Toolbox": {
   "containerToolboxes": {
       "foil": {
           "buttons": [ "Text", "Image" ]
       },
       "texture": {
           "buttons": [ "Image" ]
       },
       "spot": {
           "buttons": [ "Rectangle", "Image" ]
       }
   }
}

Properties

buttons

Defines configuration of Toolbox buttons.

Declaration

buttons: ButtonType[];

Property Value

Type	Description
ButtonType[]	Defines configuration of Toolbox buttons.

containerToolboxes

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

Declaration

containerToolboxes?: {
        [key: string]: IToolboxConfig;
    };

Property Value

Type	Description
{ [key: string]: IToolboxConfig; }	Allows for defining different toolboxes for different containers of spot colors and textures.

disabled

Is obsoleted. Left for compatibility

Declaration

disabled?: boolean;

Property Value

Type	Description
boolean	Is obsoleted. Left for compatibility

enabled

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

Declaration

enabled?: boolean;

Property Value

Type	Description
boolean	If false, hides the Toolbox. The default value is false.

insertOnTop

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.

Declaration

insertOnTop?: boolean;

Property Value

Type	Description
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.