Workbench definition

Workbench is a view that displays content items in a workspace. It’s 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. By default, JCR content apps use the tree view type.

The workbench also provides a default search box.

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 definition

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

Workbench properties

Property Description

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.

extensionViews

optional

List of extension views configured in the workbench.

Available classes:

info.magnolia.ui.contentapp.configuration.ExtensionViewDefinition
info.magnolia.ui.chooser.definition.FullTextSearchExtensionViewDefinition

You can see an example extension view configured to display analytics data in the Pages app in the analytics documentation.

filters

optional

Contains a list of info.magnolia.ui.filteringapp.filter.FilterViewDefinition. For more information, see configuring search

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.

expandHorizontally

optional, default is false for ExtensionViewDefinition and true for FullTextSearchExtensionViewDefinition

When true, the extension panel is displayed horizontally. For this to work, the view must extend com.vaadin.ui.HorizontalLayout.

icon

optional, default 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.

Feedback

DX Core

Workbench definition

Example definition

Workbench properties

Location

Main doc sections