Page tree
Skip to end of metadata
Go to start of metadata

Workbench is a view that displays content items in a workspace. It is part of the content app framework, typically defined in the browser subapp. The workbench contains a list of content views. Common view types are tree, list and thumbnail.

This workbench definition is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.ui.contentapp.configuration.WorkbenchDefinition.

If you work with the Magnolia 5 UI framework, see Workbench definition for Magnolia 5 UI instead.

Example workbench definition

workbench:
  contentViews:
    #add view definitions
  extensionViews:
    - view:
        $type: thumbnailView
      icon: icon-view-thumbnails
      expandRatio: 1f
  name: wbName

Workbench properties

contentViews

required

Parent node for the content view definitions. Defines how users can view content in the workbench.

Must contain at least one content view. For more information, see Content view definition.

implementationClass

requireddefault is Workbench.class

Class implementing info.magnolia.ui.contentapp.browser.Workbench.

extensionViews

optional

List of extension views configured in the workbench.

You can see another example of an extension view configured to display analytics data in Pages app in the Analytics Connector Pack documentation.

view

required

Actual view definition to be displayed in the extension panel. Must implement the info.magnolia.ui.ViewDefinition interface.

expandRatio

optional, default is 0

Defines how space is divided in the workbench. A value of 1f means that the extension panel occupies the same amount of space as the content panel.

icon

optionaldefault is icon-analytics-app

CSS class that identifies an icon used for the extension panel. For available names, see Icons.

name

optional, default is workbench

Name of the workbench.

  • No labels