Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: DOCU-1886
Info

The collapsible composite field is provided by the Content Editor module which is an EE Pro module.

...

Like the composite field, the collapsible composite field defines a complex field that is composed of multiple simple fields. 

Classclassinfo.magnolia.editor.app.field.CollapsibleCompositeFieldDefinition

fieldType: collapsibleComposite

The collapsible composite field is useful in content editor apps like the Stories app as shown below.

Collapsed:

...

Localtab Group
Localtab
activetrue
titleYAML file
Code Block
languagejs
form:
  tabs:
    - name: tabExample
      fields:
        - name: event
          classfieldType: info.magnolia.editor.app.field.CollapsibleCompositeFieldDefinitioncollapsibleComposite
          label: Event
          fields:
            - name: title
              classfieldType: info.magnolia.ui.form.field.definition.TextFieldDefinitiontext
              label: Title
            - name: date
              classfieldType: info.magnolia.ui.form.field.definition.DateFieldDefinitiondate
              label: Date
Localtab
titleJCR node
Advanced Tables - Table Plus
enableHeadingAttributesfalse
enableSortingfalse
classm5-configuration-tree
enableHighlightingfalse
Node nameValue

Mgnl n
form


Mgnl n
tabs


Mgnl n
tabExample


Mgnl n
fields


Mgnl n
event


Mgnl n
fields


Mgnl n
title


Mgnl p
classfieldType

textinfo.magnolia.ui.form.field.definition.TextFieldDefinition

Mgnl p
label

Title

Mgnl n
date


Mgnl p
classfieldType

dateinfo.magnolia.ui.form.field.definition.DateFieldDefinition

Mgnl p
label

Date

Mgnl p
classfieldType

collapsibleCompositeinfo.magnolia.editor.app.field.CollapsibleCompositeFieldDefinition

Mgnl p
label

Event

Include Page
_referencing fields shortcut info
_referencing fields shortcut info
You can use common field properties and the following properties in a collapsible composite field definition:

Composite field properties.

...

Properties specific to the collapsible composite field.


class

required

Definition class of the composite parent field. Use info.magnolia.editor.app.field.CollapsibleCompositeFieldDefinition.

collapsed

optionaldefault is false

Defines whether the field should be collapsed initially

.

transformerClass

optional, default is info.magnolia.ui.form.field.transformer.composite.DelegatingCompositeFieldTransformer

Custom property transformer definition

.

layout

optionaldefault is vertical

Defines the layout of the child fields: horizontal or vertical.

(warning) In custom content editor apps, this property must remain set to vertical.

transformerClass

optional, default is info.magnolia.ui.form.field.transformer.composite.DelegatingCompositeFieldTransformer

Custom property transformer definition.

Common field properties:

Include Page
_Common field properties
_Common field properties

Info
titleBest practice
Excerpt

When nesting composite fields, use the delegating transformer classes, DelegatingCompositeFieldTransformer or DelegatingMultiValueFieldTransformer, rather than the other available transformer classes.