New UI Forms

Magnolia 6.4 UI is based on front-end technology (React) and a custom front-end design system built from the ground up for accessibility.

Magnolia’s New UI Forms and design system support equal access for everyone. They offer a modern design and help you build more readable, consistent, performant, and usable forms. Furthermore, it preserves your current features and improves their accessibility.

New UI Form example

Viewing New UI Forms

New UI Forms use the existing Magnolia form definitions but don’t support every field or every property. When a form definition is fully supported, the new form is displayed. Otherwise, the system will fall back to the standard Vaadin form. In this case, problems are shown in the Definitions app to indicate which features aren’t supported in the new UI. Set the new Problem type filter to UNSUPPORTED or IGNORED to see them.

Support for more fields is in development, but not all of the current behavior will be supported. To streamline the product, we’ll remove some rarely used features. See Current and planned support for more details.

Possible issues

Determine why a form is displayed as a Vaadin form

Are you seeing Vaadin forms instead of the New UI Forms?

  • Open the Definitions app, and switch to the Problems subapp.

  • Use the new Problem type filter and choose UNSUPPORTED.

  • You will now see the problems causing the form to display the Vaadin form.

See Current and planned support for details on which features we still plan to support in the future.

Check which properties are being ignored

Open the Definitions app, and switch to the Problems subapp. Use the new Problem type filter and choose IGNORED.

If it’s important for you that these properties are used in the form and not ignored, you can force a form to be displayed in Vaadin by setting the $type of the form to vaadinForm.

...
    detail:
        label: My App detail
        form:
            $type: vaadinForm
            properties:
...

See Current and planned support for a full list of which properties are ignored.

See all the problems of a form

In the Problems subapp, only the first problem of each definition is displayed. To see all the problems of a form, check the checkbox on the left to select the problem and use the Export problems action in the Action bar. A text file will be exported.

Use the new forms and Vaadin forms in parallel

Not every form type is supported as a New UI Form due to the many custom fields included in extensions or customer projects. There will be a transition period. You can continue to use Vaadin forms and upgrade them to the new forms as appropriate.

Current and planned support

This section outlines which standard Magnolia fields and related features are supported in the new UI.

Standard form fields supported

The standard fields are described in the Field definition section of the Magnolia documentation.

Supported fields Fields not yet fully supported

checkBoxField

jsonComboBoxField

checkBoxGroupField

jsonLinkField

compositeField

sliderField

damLinkField

staticField

comboBoxField

dateField

jcrMultiField

jcrMultiLinkField (renders as jcrMultiField)

jcrMultiValueField

listSelectField

pageLinkField

radioButtonGroupField

richTextField

textField

tokenField (renders as comboBoxField)

twinColSelectField (renders as comboBoxField)

switchableField

passwordField

linkField

The fields from the Magnolia Extensions and custom fields are not yet supported.

Features not yet supported

For the standard fields, several features aren’t supported yet:

Form layouts are not supported as they lack the flexibility of previous versions and therefore are not even planned for future development.
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules