Interface ISingleButton

A structure defining configuration of the Toolbox using the action property.

Inheritance

IItem

ISingleButton

Package: @aurigma/design-editor-iframe

Examples

The following two examples are equal and result in the same toolbar configuration.

"Toolbox": {
   "buttons": [
       {
           "translationKey": "Toolbox.TEXT",
           "translationKeyTitle": "Toolbox.TITLE_ADD_TEXT",
           "iconClass": "cc-icon-add-text",
           "buttons": [
               {
                   "translationKey": "Toolbox.ADD_TEXT",
                   "translationKeyTitle": "Toolbox.TITLE_ADD_TEXT",
                   "iconClass": "cc-icon-add-text",
                   "action": "Text"
               },
               {
                   "translationKey": "Toolbox.BOUNDEDTEXT",
                   "translationKeyTitle": "Toolbox.TITLE_ADD_BOUNDEDTEXT",
                   "iconClass": "cc-icon-rich-text",
                   "action": "BoundedText"
               }
           ]
       },
       {
           "translationKey": "Toolbox.IMAGE",
           "translationKeyTitle": "Toolbox.TITLE_ADD_IMAGE",
           "iconClass": "cc-icon-add-image",
           "action": "Image"
       }
   ]
}

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

Properties

action

The action that the button performs. You can define the Toolbox by using the actions alone.

Declaration

action: ButtonAction;

Property Value

Type	Description
ButtonAction	The action that the button performs. You can define the Toolbox by using the actions alone.