Description
Configuration reference: Descrição
Overview
The Description component provides a rich text editor for longer text content with formatting support. Unlike the text field which stores plain text, the description component supports bold, italic, headings, lists, links, and other formatted content.
Rich text content
Editor features
In forms, the description field renders as a rich text editor in a single box: the sections (if any) as chips, the one-line toolbar, the text and, with a character limit, the counter. Read-only shows no toolbar.
When the toolbar is enabled, the line holds, from left to right:
- The style selector: Parágrafo, Título 1, Título 2 and Título 3.
- Negrito (bold), itálico (italic), sublinhado (underline) and rasurado (strikethrough).
- Lista (bulleted), lista numerada (numbered) and lista de verificação (checklist).
- Ligação (link), citação (quote) and bloco de código (code block).
- The ⋯ menu, with undo, redo, indent, outdent, inline code, align (left, center, right, justify), subscript, superscript, text colour, background colour, clear formatting and, if the field has content templates, Inserir modelo. The colours open a grid of swatches, with Limpar to remove the colour.
With a mouse, when the line does not fit, the groups move into the ⋯ in this order: link, quote and code block; lists; the style selector; and finally bold, italic, underline and strikethrough. On touch, the line scrolls horizontally. The ⋯ never leaves.
Shortcuts
Each button's tooltip and the ⋯ rows show the shortcut (Cmd instead of Ctrl on macOS):
| Action | Shortcut |
|---|---|
| Bold, italic, underline | Ctrl+B, Ctrl+I, Ctrl+U |
| Strikethrough | Ctrl+Shift+X |
| Bulleted list, numbered list, checklist | Ctrl+Shift+L, Ctrl+Shift+O, Ctrl+Shift+C |
| Link, quote | Ctrl+K, Ctrl+Shift+B |
| Undo, redo | Ctrl+Z, Ctrl+Y (on macOS, Cmd+Shift+Z to redo) |
| Indent, outdent | Tab, Shift+Tab |
| Inline code | Ctrl+E |
| Clear formatting | Ctrl+\ |
Sections
The description component supports predefined sections: structured areas within the content, shown as chips in a row above the toolbar. With Allow user sections, a + at the end of the row adds sections. Right-clicking a chip, or long-pressing it, opens a menu to rename the section or, when there is more than one, delete it.
| Setting | Description |
|---|---|
| Default sections | Pre-configured section headers that appear when creating a new record (e.g., "Summary", "Details", "Notes") |
| Allow user sections | When enabled, users can add their own custom section headers beyond the defaults |
Configuration
| Setting | Description |
|---|---|
| Placeholder | Hint text shown when the editor is empty |
| Show toolbar | Display the formatting toolbar (hide for a cleaner, minimal editing experience) |
| Maximum characters | Empty for no limit. With a limit, an "n / max" counter appears at the bottom of the box and turns to the error colour when exceeded; it is a warning, it does not stop typing or saving. With sections, the limit applies to each section |
| Content templates | Ready-made texts inserted at the cursor with Inserir modelo, in the toolbar's ⋯ menu |
| Default value | Pre-filled content for new records |
In tables and list views, the description displays as formatted HTML content, truncated to fit the available space.