Versions Compared

Old Version 58

changes.mady.by.user Ashraf Khamis

Saved on

compared with

New Version Current

changes.mady.by.user Ashraf Khamis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

This form definition is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.ui.editor.FormDefinition.

If you work with the Magnolia 5 UI framework, see Form definition for Magnolia 5 UI instead.

Table of Contents

Example

...

definition

Code Block
languageyml
form:
  properties:
    salutation:
      label: Salutation
      $type: textField
      i18n: true
    firstName:
      label: First name
      $type: textField
      required: true
    lastName:
      label: Last name
      $type: textField
      required: true
    email:
      label: Email
      $type: textField
      required: true
      validators:
        email:
          $type: emailValidator
    phone:
      label: Phone
      $type: textField
      required: true

...

Form properties

properties

required

A list List of editor property definition items (typically, a list of fields).

See Field definition for more information.

layout

optional, default is info.magnolia.ui.framework.layout.FormLayoutDefinition

Defines the form layout. The value must be a subtype of info.magnolia.ui.framework.layout.LayoutDefinition.

See Layout types for more information.

...

$typeclass

declarativeLayout

info.magnolia.ui.framework.layout.DeclarativeLayoutDefinition

defaultEditorActionLayoutinfo.magnolia.ui.dialog.layout.DefaultEditorActionLayoutDefinition

form

info.magnolia.ui.framework.layout.FormLayoutDefinition

horizontal

info.magnolia.ui.framework.layout.HorizontalLayoutDefinition
stackedinfo.magnolia.ui.framework.layout.StackedLayoutProducer

tabbedLayout

info.magnolia.ui.framework.layout.TabbedLayoutDefinition

Default layout

With the default layout

Javadoc resource link
classNameinfo.magnolia.ui.framework.layout.FormLayoutDefinition
renderTypeasynchronous
, it is not possible to configure anything. Use this layout when there is no need for customization.

(info) From Magnolia 6.2.1, FormLayoutDefinition has replaced the deprecated PlainFormLayoutDefinition as the default layout.

Tabbed layout

With the tabbed layout

Javadoc resource link
classNameinfo.magnolia.ui.framework.layout.TabbedLayoutDefinition
renderTypeasynchronous
, you can organize components into tabs.

Code Block
languageyml
titleExample tabbed layout definition
collapsetrue
layout:
  $type: tabbedLayout
  tabs:
    personal:
      fields:
        - name: salutation
        - name: firstName
        - name: lastName
    details:
      fields:
        - name: email
        - name: phone

Horizontal layout

With the horizontal layout

Javadoc resource link
classNameinfo.magnolia.ui.framework.layout.HorizontalLayoutDefinition
renderTypeasynchronous
, you can arrange components horizontally. To disable spacing between components, set the spacing property to false.

Code Block
languageyml
titleExample horizontal layout definition
collapsetrue
layout:
  $type: horizontal
  fields:
    - name: salutation
      label$type: SalutationtextField
      $typelabel: textFieldSalutation
    - name: firstName
      $type: textField
      label: First name
    - name: lastName
      $type: textField
      label: Last name

Stacked layout

With the stacked layout

Javadoc resource link
classNameinfo.magnolia.ui.framework.layout.StackedLayoutProducer
renderTypeasynchronous
, you can arrange components vertically. Any captions are placed above the respective components, which means that more horizontal space is allocated to the components themselves. This is the default layout for composite fields.

Code Block
languageyml
titleExample stacked layout definition
collapsetrue
layout:
  $type: stacked
  fields:
    - name: salutation
      label$type: SalutationtextField
      $typelabel: textFieldSalutation
    - name: firstName
      $type: textField
      label: First name
    - name: lastName
      $type: textField
      label: Last name

Declarative layout

With the declarative layout

Javadoc resource link
classNameinfo.magnolia.ui.framework.layout.DeclarativeLayoutDefinition
renderTypeasynchronous
, you can create form entries in an arbitrary Vaadin component container using the Vaadin declarative syntax. Use this layout for full customization.

...

Info

If VerticalLayout.java is stored in src/main/java/info/magnolia/contacts/layout, my-style.css should be added to src/main/resources/info/magnolia/contacts/layout.

...

Action layout

With the editor action layout

Javadoc resource link
classNameinfo.magnolia.ui.dialog.layout.DefaultEditorActionLayoutDefinition
renderTypeasynchronous
, you can define an action area in both dialogs and the detail subapps of content apps. This is the default layout for dialog footers and includes predefined primary and secondary actions.

...