Versions Compared

Old Version 58

changes.mady.by.user Julie Legendre

Saved on

compared with

New Version Current

changes.mady.by.user Julie Legendre

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Include Page
_What is a workbench
_What is a workbench

Info

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.

Table of Contents

Example workbench definition

Code Block
languageyml
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

required, default is Workbench.class

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

extensionViews

Anchor
anc-extensionViews
anc-extensionViews
optional

List of extension views configured in the workbench.

Tip

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

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.