Versions Compared

Old Version 3

changes.mady.by.user Ashraf Khamis

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

Workbench definition

...

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:
  dropConstraintClasscontentViews: info.magnolia.ui.workbench.tree.drop.AlwaysTrueDropConstraint
    #add view definitions
  editable: falseextensionViews:
    - view:
  contentViews:
  contentTools:

...

      $type: thumbnailView
      icon: icon-view-thumbnails
      expandRatio: 1f
  name: wbName

Workbench properties

optional , default is AlwaysTrueDropConstraint

A drag-and-drop constraint class. By restricting the nodes that a user can move you can enforce a certain node hierarchy. For example, you might want to allow content to be moved under folders but not folders under content. If the class is not defined, the  AlwaysTrueDropConstraint is set as default. When you write your own class, implement the  workbenchtreedrop.DropConstraint interface.info.magnolia.ui.workbench.contenttoolViewDefinition interface.ContentToolDefinition.)

contentViews

required

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

Must  The parent node for the specific content view definitions. It must contain at least one content view. For more information, see  see Content view definition.

dragAndDrop implementationClass
Javadoc
0

optional required, default is true

Set to false to disable drag and drop operations in the workbench.

dropConstraintClass

 default is Workbench.class

Class implementing

info.magnolia.ui.

contentapp.

browser.

editable

optional

Makes the workbench editable inline. You can double-click a cell to edit its value. Works only for columns which are also configured as editable.

Inline editing is available only in the tree view, not in list, thumbnail or search views.

Definining a default action will override inline editing. Double-clicking the cell with trigger the default action instead of inline edit mode.

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

contentTools

optional

A list of configured content tools. (A content tool must be configured with

Javadoc
0
Javadoc
0info.magnolia.ui.workbench.WorkbenchPresenter
is implemented in a way that it automatically configures a "search box" if you have both list and search view defined. 

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.