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

ITabDescriptorParsed Interface

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

A structure defining tubs of the Image Gallery.

example

clientConfig.json

"GalleryDialog": {
    "defaultTabName":  "User",
    "tabs": [
      {
          "name": "User",
          "type": "user",
          "translationKey": "GalleryDialog.TAB_USER",
          "showFileName": false,
          "canEdit": true,
          "canUpload": true,
          "actionMode": { "psd": "merged" }
      },
      {
          "name": "Facebook",
          "type": "facebook",
          "canEdit": true,
          "appKey": "123456789012345"
      }
    ]
}

Properties

Optional actionMode

actionMode: IActionModeParsed

Defines how the Image Gallery should import SVG and PSD graphics. For details, see the Using the Image Gallery topic.

Optional appKey

appKey: string

The Instagram or Facebook identifiers for your application. For details, see the Integration with Facebook and Instagram topic.

Optional canDelete

canDelete: boolean

Enables an ability to delete images on the "user" tabs. If true, the Delete button appears in the Gallery. The default value is true for tabs of the "user" type, and false for others.

Optional canEdit

canEdit: boolean

Enables an ability to edit images on the tab. If true, the Edit button appears in the Gallery. The default value is true.

Optional canUpload

canUpload: boolean

Enables an ability to upload images on the "user" tabs. If true, the Upload files button appears in the Gallery. The default value is true for tabs of the "user" type, and false for others.

Optional categoriesEnabled

categoriesEnabled: boolean

Enables a list of subfolders on the tab. The default value is true.

Optional name

name: string

The unique tab name.

Optional showFileName

showFileName: boolean

Enables file names for images. On the "facebook" tab, file names are not displayed regardless of this property. The default value is true.

Optional subFolderName

subFolderName: string

Sets a subfolder of the ~\PublicGalleryFolder\ folder that will be displayed as the Public files in the Gallery. By default, the entire content of the ~\PublicGalleryFolder\ folder is displayed.

Optional translationKey

translationKey: string

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

Optional type

type: GalleryDialogTabType

The tab type; it can be one of the following: "user", "public", "background", "facebook", or "instagram".