Interface IItem

A structure defining common properties of buttons in the Toolbox.

Package: @aurigma/design-editor-iframe

Examples

"Toolbox": {
   "buttons": [
       {
           "translationKey": "Toolbox.ADD_TEXT",
           "translationKeyTitle": "Toolbox.TITLE_ADD_TEXT",
           "nameDialogEnabled": true,
           "iconClass": "cc-icon-add-text",
           "action": "Text"
       },
       {
           "translationKey": "Toolbox.IMAGE",
           "translationKeyTitle": "Toolbox.TITLE_ADD_IMAGE",
           "nameDialogEnabled": true,
           "iconClass": "cc-icon-add-image",
           "action": "Image"
       }
   ]
}

Properties

iconClass

The class of the button icon. You can learn how to customize icons in the Custom icons topic.

Declaration

iconClass: string;

Property Value

Type	Description
string	The class of the button icon. You can learn how to customize icons in the Custom icons topic.

itemConfig

A structure containing the default configuration of new design elements.

Declaration

itemConfig?: ITextItemData | IImageItemData | IBarcodeItemData;

Property Value

Type	Description
ITextItemData | IImageItemData | IBarcodeItemData	A structure containing the default configuration of new design elements.

nameDialogEnabled

Enables a dialog box to type in the name of a new design element. The default value is false.

Declaration

nameDialogEnabled: boolean;

Property Value

Type	Description
boolean	Enables a dialog box to type in the name of a new design element. The default value is false.

translationKey

The translation key of the button caption. The corresponding string should be defined in the ~/Configuration/translations.json file.

Declaration

translationKey: string;

Property Value

Type	Description
string	The translation key of the button caption. The corresponding string should be defined in the ~/Configuration/translations.json file.

translationKeyTitle

The translation key of the button tooltip. The corresponding string should be defined in the ~/Configuration/translations.json file.

Declaration

translationKeyTitle: string;

Property Value

Type	Description
string	The translation key of the button tooltip. The corresponding string should be defined in the ~/Configuration/translations.json file.