Editor definition - 5 UI

Deprecated

Editor definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.

Its configuration is now partly integrated into DetailDescriptor in Subapp descriptor for Magnolia 6 UI.

What is an editor

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

Property Description

Property	Description
`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. Contains the action area configuration. For an example, see Configuring secondary actions.
`secondaryActions`	optional Add subnodes to match the secondary actions defined in the `actions` node. The order of the subnodes defines the sequence in which they are rendered. A ctions configured under `secondaryActions` are rendered on the left and other actions are on the right side.
`<actionName>`	required Name of a secondary action.
`actionRenderers`	optional Define a subnode for each action which requires its own renderer.
`<actionName>`	required Name of the secondary action.
`rendererClass`	required A renderer class if the secondary action requires one. Must implement `ActionRenderer`.
`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.

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. Contains the action area configuration.

For an example, see Configuring secondary actions.

secondaryActions

optional

Add subnodes to match the secondary actions defined in the actions node. The order of the subnodes defines the sequence in which they are rendered. A ctions configured under secondaryActions are rendered on the left and other actions are on the right side.

<actionName>

required

Name of a secondary action.

actionRenderers

optional

Define a subnode for each action which requires its own renderer.

<actionName>

required

Name of the secondary action.

rendererClass

required

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

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.

Feedback

DX Core

Editor definition - 5 UI

What is an editor

Location

Main doc sections