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

RichTextFieldDefinition renders a rich text editor. This is a custom Magnolia field that implements the CKEditor component.

This rich text field definition is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.ui.field.RichTextFieldDefinition.

If you work with the Magnolia 5 UI framework, see Rich text field for Magnolia 5 UI instead.

Example rich text field definition

richText:
  label: Text editor
  $type: richTextField
  height: 500
  tables: true
  source: true

Rich text field properties

alignment

optional, default is false

Allows text alignment for paragraphs. When set to true, this property adds alignment buttons (left, center, right, and justify) to the toolbar.

colors

optional

Colors displayed in the color selector. Comma-separated hexadecimal color codes without the # prefix (for example, 00923E,F8C100,28166F). See CKEditor documentation for more information.

configJsFile

optional

Location of a custom CKEditor configuration file (for example, /.resources/ckeditor/config-magnolia.js). You can link to a file in the resources workspace, file system or classpath. See Origins and loading order for more information.

The default configuration files can be found in magnolia-ui-framework/src/main/resources/mgnl-resources/ckeditor/:

  • config-magnolia.js (Git): Magnolia configuration file.
  • config-default.js (Git): CKEditor configuration file.

(warning) If you use a custom configuration file, Magnolia will ignore all other configured properties.

A custom configuration allows you control over the config.extraPlugins setting, but it also means you need to add the magnolialink and magnoliaFileBrowser plugins to your file. See the default config-magnolia.js for how to include the plugins.

fonts

optional

List of font names displayed in the font selector. Separate entries with a semi-colon (for example, Arial/Arial,sans-serif;Times New Roman/Times New Roman,serif). It is possible to have more than one font for each entry separated by a comma. A display name may be optionally defined by prefixing the entries with the name and the slash character. See CKEditor documentation for more information.

fontSizes

optional

List of fonts sizes displayed in the font selector. Separate entries with a semi-colon (for example, 16/16px;24/24px;48/48px). Any CSS-supported size can be used (for example, 12px, 2.3em, 130%, larger or x-small). A display name may be optionally defined by prefixing the entries with the name and the slash character. For example, Bigger Font/14px will be displayed as Bigger Font in the list and outputted as 14px. See CKEditor documentation for more information.

height

optional, default is -1

Height of the field (including the toolbar). This property accepts an integer (to denote a value in pixels). Value of -1 means that the component will take the minimum necessary space.

images

optional, default is false

Allows images from the DAM. When set to true, this property adds an image button to the toolbar. The user can define the size and alignment of the image and some metadata.

lists

optional, default is true

Allows bulleted and numbered lists. When set to false, this property removes list buttons from the toolbar.

source

optional, default is false

Allows toggling between text and HTML editing. When set to true, this property adds a source button to the toolbar.

tables

optional, default is false

Allows tables. When set to true, this property adds a table button to the toolbar.

See also Common field properties.

Decoding text

CKEditor produces HTML such as <p> elements for paragraphs. However, text stored in JCR usually escapes HTML code. To render text that originates from a rich text field, you need to decode the stored content to make sure the HTML tags are rendered properly again.

Here is how to decode the content object and get the desired property from it:

${cmsfn.decode(content).text!""}

See cmsfn Decode HTML for more information.

(warning) Because a rich text editor adds HTML to your content, the HTML will be indexed by search engines along with the content.

  • No labels