Uploaded image for project: 'Magnolia UI'
  1. Magnolia UI
  2. MGNLUI-6166

Switchable field: change configuration "field" to "switcher" to avoid the confusion

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Neutral
    • None
    • None
    • None
    • None
    • Yes

    Description

      In info.magnolia.ui.editor.SwitchableFormDefinition, field definition represents for the button groups or checkboxes, but the name is field makes user confusing. It should be rename to switcher (}}consider also{{ options)

      In the example, the field makes me think about the whole field in switchable, then they can put the definition property in the wrong place. And the name somehow doesn't show clearly which part is in switchable field (we have 2 parts: the switcher and the subform)

         switchable:
                label: switchable haha
                i18n: true
                $type: switchableField
                field:
                  $type: radioButtonGroupField
                  defaultValue: foo
                  layout: horizontal
                  datasource:
                    $type: optionListDatasource
                    options:
                      - name: foo
                        value: foo
                      - name: bar
                        value: bar
                itemProvider:
                  $type: jcrChildNodeProvider
                forms:
                  - name: foo
                  .....
      

      Note: Make sure backward compatibility

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                Unassigned Unassigned
                sang.ngo Sang Ngo Huu
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                  Created:
                  Updated:

                  Checklists

                    Task DoD