Collapsible composite field - 5 UI

Deprecated

Collapsible composite field definition has been deprecated since Magnolia 6.0. It extends info.magnolia.ui.form.field.definition.CompositeFieldDefinition of Magnolia 5 UI. There is no corresponding implementation that would extend info.magnolia.ui.field.CompositeFieldDefinition of Magnolia 6 UI.

This field is provided by the Content Editor module, which is a DX Core module.

CollapsibleCompositeFieldDefinition extends the composite field to add a clickable header that toggles the visibility of the field’s content. Editors can click the header to show and hide the subfields.

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

class: info.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:

image

Expanded:

image

Collapsible composite field properties

Simple collapsible composite field definition:

form:
  tabs:
    - name: tabExample
      fields:
        - name: event
          fieldType: collapsibleComposite
          label: Event
          fields:
            - name: title
              fieldType: text
              label: Title
            - name: date
              fieldType: date
              label: Date

Referencing fields shortcut info - 5 UI

See Referencing fields for further information.

Property Description

<collapsible composite field name>

required

Name of the parent composite field.

fields

required

Node containing child fields.

<child field names>

required

Name of the child fields. You can use any simple field definition.

class

required

Field definition class of the child field.

<child field properties>

required/optional

Any properties the child field supports.

Properties specific to the collapsible composite field:

class

required

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

collapsed

optional, default is false

Defines whether the field should be collapsed initially.

layout

optional, default is `vertical`

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

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

transformerClass

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

Common field properties - 5 UI

Property Description

fieldType`or `class

required

Defines the field type via either a field alias name or a fully-qualified field definition class name. See Field definition: Field types.

To check the correct form of the name, use the Definitions app.

defaultValue

optional

Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.

Applied only when creating a new item, not for already existing items.

description

optional

Help text displayed when the user clicks the help icon. The value can be literal or retrieved from the message bundle with a key. Use alphanumeric characters in literal values. Not applicable to the static field.

i18n

optional, default is false

Enables i18n authoring support which allows editors to write foreign-language or regionally targeted content. A two-letter language identifier (en, de, fr etc.) is displayed on controls where i18n is set to true.

i18nBasename

optional, default is the message bundle defined in the dialog definition_

Message bundle such as com.example.messages for localized field labels. You can set this property in the parent dialog, form or tab definition. Child fields will inherit the bundle.

label

optional

Field label displayed to editors. The value can be literal such as Product name or retrieved from the message bundle with a key such as products.product.label. Use alphanumeric characters in literal values.

If you do not provide the property, Magnolia will fall back to a generated i18n key and display the key in the UI.

If you do not want a label at all, define the property and set its value to a blank space such as label: " " in YAML.

name

optional, default is the name of the field’s parent node_

Name of the node where the value is saved. The name jcrName is reserved. Use alphanumeric characters.

placeholder

optional

Placeholder text to be displayed when the field is empty. The value is i18n-able.

Applicable to text, link and combobox fields.

readOnly

optional, default is false

Makes the field uneditable. Adding this property has the same effect as creating a static field.

required

optional, default is false

Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values.

requiredErrorMessage

optional, default is This field is required

Error message displayed when required is true and the user saves an empty field. The value can be literal or retrieved from the message bundle with a key such as validation.message.required.

styleName

optional

Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names such as checkbox disabled. The style name will be rendered as an HTML class name, which can be used in a CSS definition. The class name is added to the field by calling the Vaadin method addStyleName.

transformerClass

optional

Property transformer classes define how field values are stored in the repository. Each field has a default transformer class. You don’t need to define a class unless you want to override the default. The value is a fully-qualified class name.

Complex field definitions may define a different default transformer in their constructor. See Transforming field values for more.

type

optional, most fields set a default value automatically

JCR property type of the stored value such as String, Boolean, Date or any other supported and defined data type.

Best practice

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

dev days event sign up
dev days event sign up
Feedback