Page tree
Skip to end of metadata
Go to start of metadata

SwitchableFieldDefinition defines a field that displays alternative fields depending on user choice. For example:

  • Switch between a plain text editor and a rich text editor.

  • Authenticated vs. unauthenticated SMTP settings. When the user selects the authenticated option, ask for username and password.

  • In a shop, switch between separate shipping and billing addresses or using the same address for both..

The class: info.magnolia.ui.form.field.definition.SwitchableFieldDefinition

The fieldType: switchable

Here is a switchable text editor field. It consists of alternative text and rich text fields.

Switchable field properties

Simple switchable field definition:

form:
  tabs:
    - name: tabText
      label: Text
      fields:
        - name: message
          fieldType: switchable
          label: Message
          options:
            - name: plainText
              label: Plain
              selected: true
              value: plainText
            - name: richText
              label: Rich
              value: richText
          fields:
            - name: plainText
              fieldType: text
              label: Plain text message
              rows: 5
            - name: richText
              fieldType: richText
              label: Rich text message
              height: 200
Node nameValue

 form


 tabs


 tabText


 fields


 message


 options


 plainText


 label

 Plain

 selected

 true

 value

 plainText

 richText


 label

 Rich

 value

 richText

 fields


 plainText


 fieldType

text

 label

Plain text message

 rows

5

 richText


 fieldType

richText

 label

Rich text message

 height

200

 fieldType

switchable

 label

Message

See Referencing fields for further information.

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

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

Best practice

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

  • No labels