IItem Interface

A structure defining common properties of the Left Toolbar Buttons. These are the basic button definitions.

example

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

"LeftToolbar": {
    "buttons": [
        {
            "translationKey": "LeftToolbar.TEXT",
            "translationKeyTitle": "LeftToolbar.TITLE_ADD_TEXT",
            "iconClass": "cc-icon-add-text",
            "buttons": [
                {
                    "translationKey": "LeftToolbar.ADD_TEXT",
                    "translationKeyTitle": "LeftToolbar.TITLE_ADD_TEXT",
                    "iconClass": "cc-icon-add-text",
                    "action": "Text"
                },
                {
                    "translationKey": "LeftToolbar.RICHTEXT",
                    "translationKeyTitle": "LeftToolbar.TITLE_ADD_RICHTEXT",
                    "iconClass": "cc-icon-rich-text",
                    "action": "RichText"
                }
            ]    
        },
        {
            "translationKey": "LeftToolbar.IMAGE",
            "translationKeyTitle": "LeftToolbar.TITLE_ADD_IMAGE",
            "iconClass": "cc-icon-add-image",
            "action": "Image"
        }
    ]
}

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

Properties

iconClass

iconClass: string

The class of the button icon.

translationKey

translationKey: string

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

translationKeyTitle

translationKeyTitle: string

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