View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

ITabConfig Interface

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

A structure defining tabs of the Asset Manager.

example
{
  "widgets": {
    "AssetManager": {
      "defaultTabName": "External urls",
      "tabs": [
        {
          "name": "My files",
          "assetSourceInstance": "My files",
          "iconClassName": "cc-icon-uploadable",
          "controls": {
            "canDelete": false,
            "toolbarEnabled": false,
            "selectAllButtonEnabled": true
          }
        },
        {
          "name": "Public Gallery",
          "assetSourceInstance": "Public Gallery",
          "iconClassName": "cc-icon-add-image",
          "controls": {
            "categoriesEnabled": false
          }
        },
        {
          "name": "External urls",
          "assetSourceInstance": "[source]External urls",
          "iconClassName": "cc-icon-add-image",
          "controls": {
            "assetNameEnabled": false,
            "insertToAllButtonEnabled": true
          }
        }
      ]
    }
  }
}

Properties

assetSourceInstance

assetSourceInstance: string

A name of the structure defining a type, categories, titles, and links to the assets. For details, you can refer to the IAssetSources interface.

Optional controls

controls: object

Additional settings.

controls declaration

  • Optional assetNameEnabled: boolean

    Enables the asset title. The default value is true.

  • Optional canDelete: boolean

    Allows your users to delete images on the "My files" tab. If true, the Delete button appears on this tab. The default value is true for the PrivateSource. Users cannot delete assets from other asset sources.

  • Optional canEdit: boolean

    Allows your users to edit images on the "My files" tab. If true, the Edit button appears on this tab. The default value is true.

  • Optional canUpload: boolean

    Allows your users to upload images on the "My files" tab. If true, the Upload files button appears on this tab. The default value is true for the PrivateSource. Users cannot upload assets to other asset sources.

  • Optional categoriesEnabled: boolean

    Enables the Categories panel. The default value is true.

  • Optional extensionEnabled: boolean

    Enables the asset file extension. The default value is true.

  • Optional insertToAllButtonEnabled: boolean

    Enables the Insert to all button that allows your users to change backgrounds of all product surfaces at once. The default value is false.

  • Optional selectAllButtonEnabled: boolean

    Enables the Select all button that allows your users to select all images on the asset tab. The default value is false.

  • Optional toolbarEnabled: boolean

    Enables the Asset Manager toolbar with the search box and additional buttons. The default value is true.

Optional iconClassName

iconClassName: string

A class of the tab icon. You can find the complete list of available icon classes in \src\design-editor\Styles\ControlStyles\sp-icons.less.

name

name: string

The tab name.