Versions Compared

Key

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

...

<field name>Name of the field.

class

required (unless $type is used)

Fully qualified name of the checkbox field definition class.

If the definition class is annotated with info.magnolia.ui.field.FieldType, you can use the $type property instead.

$type

You can use this as a shortcut for class if the definition class is annotated with info.magnolia.ui.field.FieldType. The proper value is defined by the annotation.

Code Block
languagejava
titleExample class annotation
collapsetrue
@FieldType("checkBoxField")
public class CheckBoxFieldDefinition extends ConfiguredFieldDefinition<Boolean> {
...
}

To use the $type property in YAML, see Checkbox field - 6 UI.

buttonLabel

optional

Label displayed to the right of the checkbox.

(warning) The property is optional in the sense that if you do not want to have the label rendered at all, you have to set an empty string as its value (either in the YAML configuration or in a message bundle).

See also Common field properties.