Static field
info.magnolia.ui.field.StaticFieldViewDefinition renders non-editable text that appears next to the label. Use the field to display help text.
This static field definition is part of the Magnolia 6 UI framework.
The fully qualified class name is info.magnolia.ui.field.StaticFieldViewDefinition.
|
Example definition
static:
$type: staticField
label: Description
value: Used on search engine result pages...|
You can preview this example using the |
Field properties
Field-specific properties
| Property | Description |
|---|---|
|
required Text displayed next to the label. The value is i18n-able. |
Common complex field properties
The only relevant optional property for a static field is label.
| Property | Description | ||
|---|---|---|---|
|
required Name of the field definition item. Derived from the configured node name. Use alphanumeric characters without spaces. |
||
|
required (unless Type of the field definition item. The value must be a fully qualified
class name and a subtype of |
||
|
You can use this as a shortcut for Example class annotation
See Field types for possible values. |
||
|
optional Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle. |
||
|
optional Field label displayed to editors. The value can be literal or a key of a message bundle. If you do not provide the property, Magnolia will fall back to a generated i18n key. If you do not want to have any label, set the property to an empty
string such as |
||
|
optional Additional style information for an editor property definition item applied to the element when the form is rendered. The value can be a CSS class or a list of CSS classes separated by white spaces. 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
|