Overview
The Rich Text Editor field type (texteditor) provides a full-featured text editor with formatting capabilities. Users can apply bold, italic, headings, bulleted lists, numbered lists, links, and other formatting to their text, creating well-structured and visually clear content.
Properties
| Property | Required | Description |
|---|---|---|
| ID | Yes | The field identifier. |
| Type | Yes | Must be set to texteditor |
| Name | Yes | The display label shown to the user. |
| Width | No | The percentage width within the form section. Typically set to 100%. |
| Height | No | The height of the editor in pixels. Controls the visible editing area size. |
| Rich Toolbar | No | When set to true, displays an enhanced formatting toolbar with additional options such as font size, colour, tables, and more. When false or omitted, a basic toolbar with essential formatting options is shown. |
| Required | No | When true, the record cannot be saved without providing content. |
| Read Only | No | When true, the content is displayed but cannot be edited. |
| Visibility | No | A condition controlling when this field is visible. |
Formatting Capabilities
The Rich Text Editor supports the following formatting options:
Basic Toolbar
- Bold, italic, underline
- Bulleted and numbered lists
- Headings (multiple levels)
- Links
- Text alignment
Rich Toolbar (Extended)
When Rich Toolbar is enabled, additional options are available:
- Font size and colour
- Tables
- Images (inline)
- Block quotes
- Horizontal rules
- Code blocks
Use Cases
- Knowledge base articles — rich content with headings, lists, and links
- Procedures and policies — step-by-step instructions with numbered lists and emphasis
- Detailed descriptions — project briefs, requirements documents, or proposals
- Meeting minutes — structured notes with headings and action items
Best Practices
- Always set the width to 100% for the best editing experience
- Set the height to at least 300 pixels for content fields, or 500+ pixels for primary content areas
- Enable Rich Toolbar for fields that are the primary content area (e.g. article body text)
- Use the basic toolbar (Rich Toolbar off) for shorter formatted fields like descriptions