Page tree
Skip to end of metadata
Go to start of metadata

DEPRECATED

This text field definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.

For the updated implementation, see Text field for Magnolia 6 UI instead.

TextFieldDefinition renders an editable Text field. When the rows property is 1 or unspecified, Magnolia renders an HTML input element of type text . When rows is greater than 1, Magnolia renders a textarea .

class: info.magnolia.ui.form.field.definition.TextFieldDefinition

fieldType: text

Text field properties

Simple text field definition. 

form:
  tabs:
    - name: tabText
      label: Text
      fields:
        - name: title
          fieldType: text
          label: Title
          rows: 2
          maxLength: 600

Node name

Value

 form


 tabs


 tabText


 fields


 title


 fieldType

text

 label

Title

 maxLength

600

 rows

2

See Referencing fields for further information.

Field-specific properties:

<field name>Name of field.

rows

optional, default is 1

Number of text rows.

maxLength

optional, default is -1

Maximum number of characters allowed in the field. Value -1 means unlimited.

A counter below the field shows how many characters you have left.

Common field properties:

fieldType

or

class

required

Defines the field type via either a field alias name or a fully-qualified field definition class name. See Field definition: Field types.

To check the correct form of the name, use the Definitions app.

defaultValue

optional

Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.

(info) Applied only when creating a new item, not for already existing items.

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. Use alphanumeric characters in literal values. Not applicable to the static field.

i18n

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.

i18nBasename

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.

label

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 do not provide the property, Magnolia will fall back to a generated i18n key and display the key in the UI.

If you do not want a label at all, define the property and set its value to a blank space such as label: " " in YAML.

name

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.

placeholder

optional

Placeholder text to be displayed when the field is empty. The value is i18n-able.

(warning) Applicable to textlink and combobox fields.

readOnly

optional, default is false

Makes the field uneditable. Adding this property has the same effect as creating a static field.

required

optional, default is false

Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values.

requiredErrorMessage

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.

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 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.

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.

(warning) Complex field definitions may define a different default transformer in their constructor. See Transforming field values for more.

type

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.