Magnolia 6.1 reached end of life on March 31, 2021. This branch is no longer supported, see End-of-life policy.
RichTextFieldDefinition renders a rich text editor. This is a custom Magnolia field that implements the CKEditor component.
class: info.magnolia.ui.form.field.definition.RichTextFieldDefinition
fieldType: richText
Rich Text field properties
Simple rich text field definition.
form:
tabs:
- name: tabText
label: Text
fields:
- name: text
fieldType: richText
tables: true
height: 500
label: Text Editor
Node name | Value |
|---|---|
form | |
tabs | |
tabText | |
fields | |
text | |
fieldType | richText |
tables | true |
height | 500 |
label | Text Editor |
See Referencing fields for further information.
Field-specific properties:
| optional, default is Text alignment for paragraphs. When set to |
| optional Colors displayed in the color selectors. Comma-separated a string of hexadecimal color codes without the |
| optional Location of a custom CKEditor configuration file, e.g. The default configuration files can be found in
A custom configuration allows you control over the |
| optional List of font names displayed in the Font selector in the toolbar, for example CKEditor documentation for more. |
| optional List of fonts size displayed in the Font selector in the toolbar, for example |
| optional, default is The height of the editing area, including the toolbar, for example |
| optional, default is Allows images to be added from the DAM. When set to |
| optional, default is Allows bulleted and numbered lists. When set to |
| optional, default is Allows toggling between text and HTML editing. When set to |
| optional, default is Allows tables to be added. When set to |
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. To check the correct form of the name, use the Definitions app. |
type | required, default is Model type of the field. Use the fully qualified class name. See PropertyType for possible values. A default type is typically hard-coded in each definition class. You only need to add this property if you want to override the default implementation (for example, with |
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. Use alphanumeric characters in literal values. Not applicable to the static field. |
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.
|
Applied only when creating a new item, not for already existing items.Link buttons
There are three link buttons:
Links to external pages
Links to internal pages
Links to documents in the DAM
Loading order for custom configuration
Note that any configuration done in a RichTextFieldFactory will override configuration settings from the config.js file. This is why we ignore other properties in the field definition as soon as a configJsFile is configured.
Decode text
CKEditor produces HTML such as <p> elements for paragraphs. However, text stored in JCR usually escapes HTML code. To render text which originates from a rich text field you need to decode the stored content to make sure the HTML tags are rendered properly again.
Decode the content object and then get the desired property from it:
${cmsfn.decode(content).text!""}
See cmsfn decodeHtml.
Impact on the search index
Keep in mind that using the RTE introduces HTML into your content. The impact of this is that the HTML will be indexed along with the content.
Overview
Content Tools