Page History
...
You can use these properties with any field unless specified otherwise.
...
required
Defines the field type such as Text or Link. The value is a fully-qualified field definition class name such as info.magnolia.ui.form.field.definition.TextFieldDefinition
.
Can be replaced with the fieldType
property.
...
required
Defines the field type via a field alias name such as text
for the text field or link
for the link field.
May be used instead of the class
property. Use the Definitions app to check the correct form of the name.
...
optional
Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.
Applied only when creating a new item, not for already existing items.
...
optional , default is false
Enables i18n authoring support which allows editors to write foreign-language or regionally targeted content. A two-letter language identifier (en, de, fr etc.) is displayed on controls where i18n
is set to true
.
...
optional , default is the name of the field's parent node
Name of the node where the value is saved. The name jcrName
is reserved. Use alphanumeric characters.
...
optional , default is false
Makes the field uneditable. Adding this property has the same effect as creating a Static field.
...
optional , default is false
Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values.
...
optional , default is "This field is required"
Error message displayed when required is true and the user saves an empty field. The value can be literal or retrieved from the message bundle with a key such as validation.message.required
.
...
optional
Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names such as checkbox disabled
. The style name will be rendered as an HTML class name, which can be used in a CSS definition. The class name is added to the field by calling the Vaadin method addStyleName.
...
optional
Property transformer classes define how field values are stored in the repository. Each field has a default transformer class. You don't need to define a class unless you want to override the default. The value is a fully-qualified class name such as info.magnolia.ui.form.field.transformer.composite.CompositeTransformer
.
Complex field definitions may define a different default transformer in their constructor. See Transforming field values for more.
...
optional , most fields set a default value automatically
JCR property type of the stored value such as String
, Boolean
, Date
or any other supported and defined data type.
...
optional , default is the message bundle defined in the dialog definition
Message bundle such as com.example.messages
for localized field labels. You can set this property in the parent dialog, form or tab definition. Child fields will inherit the bundle.
...
optional
Field label displayed to editors. The value can be literal such as Product name
or retrieved from the message bundle with a key such as products.product.label
. Use alphanumeric characters in literal values.
If you don't provide the property then Magnolia falls back to a generated i18n key and displays they key in the UI.
If you don't want a label at all then define the property and set its value to empty space such as label: " "
in YAML.
...
optional
Help text displayed when the user clicks the help icon. The value can be literal or retrieved from the message bundle with a key such as products.product.description
. Use alphanumeric characters in literal values. Not applicable to the Static field.
...
optional
The placeholder text to be displayed in the empty field. The property replaces placeholder text field.
Applicable in text and link fields.
Include Page | ||||
---|---|---|---|---|
|
...
Field types
Include Page | ||||
---|---|---|---|---|
|
...