Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.
The expanding text field is provided by the Content Editor module, which is an EE Pro module.
The ExpandingTextFieldDefinition is similar to the placeholder text field and provides an additional property named maxRows
. (Note that this field indirectly extends the text field, which has the rows
property.)
As the name of the field suggests, the field's vertical size expands proportionally with the increasing amount of the text entered, until it reaches the value of the maxRows
property at which point a scroll bar will appear.
class: info.magnolia.editor.app.field.ExpandingTextFieldDefinition
fieldType: expandingText
The expanding text field is useful in the apps based on the Content editor such as the Stories app:
Before selecting the field
Selected
With the initial number of rows
With the maximum number of rows
With a scroll bar
The field can also be used in a dialog for a component:
It works in exactly the same way as in a Content editor app. (Not showing all states here.)
Field definition
authorBio: fieldType: expandingText rows: 2 maxRows: 5 # label: Author biography # placeholder: Provide some info about the author ...
Node name | Value |
---|---|
fields | |
authorBio | |
fieldType | expandingText |
rows | 2 |
maxRows | 5 |
Properties:
<field name> | The name of field. |
| optional, default is The maximum number of rows to which the field may expand before showing a scroll bar. |
| optional, default is The number of text rows for the initial state of the field. This property is defined in TextFieldDefinition. |
or
| required Defines the field type via either a field alias name or a fully-qualified field definition class name. See Field definition: Field types. Use the Definitions app to check the correct form of the name. |
defaultValue | optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.
|
description | 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 |
i18n | optional, default is 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 |
i18nBasename | optional, default is the message bundle defined in the dialog definition Message bundle such as |
label | optional Field label displayed to editors. The value can be literal such as 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 |
name | optional, default is the name of the field's parent node Name of the node where the value is saved. The name |
placeholder | optional The placeholder text to be displayed in the empty field. The property replaces the deprecated placeholder text field.
The field is optional, but you should provide a translation or a hard-coded label, otherwise the empty field will display its auto-generated 18n key instead. |
readOnly | optional, default is Makes the field uneditable. Adding this property has the same effect as creating a Static field. |
required | optional, default is Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values. |
requiredErrorMessage | optional, default is 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 |
styleName | 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 |
transformerClass | 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.
|
type | optional, most fields set a default value automatically PropertyType of the stored value such as |