Magnolia 5.4 reached end of life on November 15, 2018. This branch is no longer supported, see End-of-life policy.

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

Editor is a component that edits a content item. The editor typically contains a form. In a content app, you should create an editor definition under the detail subapp. Define the node types the editor edits, a form for editing them, and actions for saving the edit.

detail:
  editor:
    nodeType:
      icon: icon-node-content
      name: mgnl:contact
    actions:
      - name: commit
      - name: cancel
    form:
      tabs:
        - name: personal
          # field definitions
Node nameValue

 detail

 

 editor

 

 nodeType

 

 icon

icon-node-content

 name

mgnl:contact

 actions

 

 commit

 

 cancel

 

 form

 

 tabs

 

 personal

 

 ...

 

Properties:

nodeType

required

A node type that this editor component can edit and save.

name

required

A Magnolia or JCR node type such as mgnl:page or mgnl:contact.

icon

optional

CSS class that identifies an icon displayed on the items in the workbench.

actions

required

Actions available in the editor. Define the actions in separate action definitions and reference them here by name.

<action-name>

required

Name of a primary action. Typically you need at least commit and cancel.

actionArea

optional

A secondary action area in the bottom left corner of the editor.

secondaryActions

optional

<action-name>

required

Name of a secondary action.

actionRenderers

optional

A renderer class if the secondary action requires one. Must implement ActionRenderer .

<action-name>

required

Name of the secondary action.

form

optional

A form definition if this editor is used to edit form-like data.

wide

optional, default is false

true opens the editor in wide mode using all available horizontal space.

Click the expand/collapse button in the top right corner to toggle between the wide and normal (720px) modes.