Rich text field
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
If you work with the Magnolia 5 UI framework, see Rich text field for Magnolia 5 UI instead. |
Example definition
richText:
$type: richTextField
label: Text editor
height: 500
tables: true
source: true
Field properties
Field-specific properties
Property | Description |
---|---|
|
optional, default is Allows text alignment for paragraphs. When |
|
optional Colors displayed in the color selector. Comma-separated hexadecimal
color codes without the |
|
|
|
optional List of font names displayed in the font selector. Separate entries with a semi-colon
(for example, |
|
optional List of fonts sizes displayed in the font selector. Separate entries
with a semi-colon (for example, |
|
optional, default is Height of the field (including the toolbar). This property accepts an
integer (to denote a value in pixels). Value of |
|
optional, default is Allows images from the DAM. When |
|
optional, default is Allows bulleted and numbered lists. When |
|
optional, default is Allows toggling between text and HTML editing. When |
|
optional, default is Allows tables. When |
|
optional List of JCR or DAM link field definitions. It can be used to provide custom chooser dialogs. Example configuration
|
Common simple field properties
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. |
||||
|
required, default is Data 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.
|
||||
|
optional Converts values between the presentation (UI) and model (stored data). The property must extend
|
||||
|
optional, default is translated Message shown when there is an error in the conversion process. The value can be literal or a key of a message bundle. |
||||
|
optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.
|
||||
|
optional Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle. |
||||
|
optional Defines the factory class that initializes and builds the Vaadin form field. The default factory class depends on the particular field. The value must be a fully qualified class name and a subtype of
|
||||
|
optional Defines the binder class that applies configuration parameters from the field. |
||||
|
optional, default is Enables i18n
authoring support, which allows editors to write foreign-language or
regionally targeted content. A two-letter language identifier ( |
||||
|
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, default is Makes the field uneditable. |
||||
|
optional, default is Makes the field required. When
|
||||
|
optional, default is translated Error message shown when |
||||
|
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
|
||||
|
optional List of field validator definition items. Any value must be a subtype of
See Field validators for more information. |
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.
Inserting hyperlinks
CKEditor provides a tabbed dialog for inserting links (such as anchor tags) into rich text. The fields of this dialog map to the following element attributes:
Field ID | Attribute | ||
---|---|---|---|
Id |
|
||
Name |
|
||
Language direction |
|
||
Language code |
|
||
Access key |
|
||
Tab index |
|
||
Advisory title |
|
||
Advisory content type |
|
||
Stylesheet classes |
|
||
Linked resource charset |
|
||
Relationship |
|
||
Force download |
|
Because a rich text editor adds HTML to your content, the HTML will be indexed by search engines along with the content. |
Customization
A custom configuration of CKEditor allows you to control the 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.
If you use a custom configuration file, Magnolia will ignore all the other configured properties. |
A custom configuration file can be located in the resources
workspace, file system or classpath
(for example, /.resources/ckeditor/config-magnolia.js
).
The default configuration files can be found in
magnolia-ui-framework-jcr/src/main/resources/mgnl-resources/ckeditor/
:
Using the CKEditor Maximize plugin may lead to display issues with the external Link to Magnolia page and Link to DAM document Magnolia functions. It is highly recommended that you use the external Expand Magnolia function instead. |
For more information about creating different CKEditor configurations to optimize the authoring experience, see Customizing the RichText field using CKEditor. |
Use case example: Latin characters
Suppose you want to change how a field encodes data, in particular, so that a text field uses Latin characters. You can achieve this by creating or editing a custom configJsFile
file. Instructions to do so and illustrations are given below.
-
Add the
config.entities_latin = false;
property to the/ckeditor/config-magnolia.js
custom file.See how to do it…
-
Update the
textImage.yaml
mkt2 component dialog file to reference the updated configuration file (e.g.,configJsFile: /.resources/ckeditor/config-magnolia.js
).See how to do it…
-
Create a page and add a new
Text and image
component, including Latin characters (e.g.,boîte à lettres
). Check that the characters are displayed properly. -
Go to the JCR app and find the page and text field you created. Check that the characters in the value field are correctly displayed.
External Magnolia functions
Function | Icon | Description |
---|---|---|
Link to Magnolia page |
Opens a chooser dialog where you can link to a page in the |
|
Link to asset |
Opens a chooser dialog where you can link to an asset in the |
|
Expand |
Expands the rich text field. |
Light rich text field
Light rich text field is a special type of rich text field provided by the Content Editor module.
Compared to the rich text field, the light rich text field has limited formatting functions. In addition, the field can only be used as a content block in a custom content editor.