Versions Compared

Key

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

...

Include Page
_referencing fields shortcut info
_referencing fields shortcut info

You can use common field properties and the following properties in a switchable field definition:

Properties:

Field-specific properties:

<field name>

required

Name of parent switchable field.

options

required

Options (radio buttons) that allow switching between child fields. You can add more than two options.

<option>

required

Options available for selection. Add one node for each option. The number of options should match the number of child fields. .

label

optional

Label displayed next to the radio button.

selected

optional

When set to true the option is selected by default.

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

value

optional

Value saved to the repository when selected. Should match the name of the corresponding child field node name.

fields

required

Child fields displayed when the user selects an option.

<child field name>

required

Child field name. Should match the value property of the corresponding option.

class

required

Field definition class of the child field. (warning) Basic upload field does not work inside a switchable field.

class

required

Definition class of the switchable parent field. Use info.magnolia.ui.form.field.definition.SwitchableFieldDefinition .

layout

optional , default is horizontal

Defines the layout of the radio buttons. Set to vertical for a vertical layout.

selectionType

optional, default is radio

Defines the selection type. Valid values are radio and select .

transformerClass

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

Custom property transformer definition

Common field properties:

Include Page
_Common field properties
_Common field properties

Info
titleBest practice
Excerpt

It can be difficult to configure the correct transformers for advanced fields and especially for fields with complex nesting.

When nesting switchable fields, use delegating field transformers such as the DelegatingCompositeFieldTransformer since normal non-delegating transformers can only handle two nesting levels.

...