RichTextEditor
variant default/comment · barra · links · listas
Editor de texto rico com barra de formatação compacta.
Formatando enquanto digita
Entrega: após as 14h, portão lateral, falar com Rita
<.rich_text_editor id="rte1" name="rte1" density="compact" loop value="<p><b>Entrega:</b> após as 14h, portão lateral, falar com Rita</p>" toolbar={[~w(bold italic link list-bullet)]} class="max-w-[520px]" />
Uso
<.rich_text_editor field={@form[:body]} toolbar={[:bold, :italic, :list, :link]} />
Regras
- Barra com ícones de 30px; estado ativo em
bg-selected. - Rodapé opcional com anexos e ação de envio.
Referência da API
Todos os function components, atributos, valores e slots que este componente cobre.
Rich text editor on a plain contenteditable (bold, italic, underline, strike, quote, code,
headings, lists, sub/superscript, indent, text direction, size, font, colors, alignment, links
and clean), plus its compact variant="comment" form for threads.
<.text_editor field={@form[:body]} placeholder="Escreva..." />
<.text_editor name="note" toolbar={[~w(bold italic underline), ~w(list-ordered list-bullet)]} />
<.text_editor name="post" filled content_class="h-72" />
<.text_editor name="comment" variant="comment" on_submit="comment"
mentions={[%{handle: "juliana-moraes", label: "Juliana Moraes"}]}
placeholder="Escreva um comentario" />
The HTML is submitted through a hidden input named like the field, and each edit fires a
bubbling input event, so phx-change runs. The HTML given to the editor is cleaned on the
server by sanitize/2 (and again in the browser, as is pasted HTML): only formatting tags and
safe links stay. Sanitize what you store as well. A value sent by the server replaces the
text; the same value echoed back does not touch it.
slash opens a menu of blocks when "/" is typed at the start of a word; variables adds the
placeholders of a template ({cliente} is drawn as a chip and goes to the server as plain
text); the :ai slot is a button at the end of the toolbar (on_ai is pushed with the HTML and
the selected text; answer with insert_html/3); footer draws a bar with a hint and the word
count. In a comment, "@" opens the list of mentions (chips sent as @handle) and
Ctrl/Cmd+Enter submits (on_submit).
Three toolbar buttons are opt-in: mark (highlight), variable and image. image asks for
the address and description, or, with on_image, pushes the event so the app can upload the
file and answer with insert_image/4.
The behaviour lives in the LedgerUI.TextEditor hook (text_editor.js); the editor needs a
stable id (from field or name).
text_editor_content/1 shows saved HTML read-only, in the editor's type.
<.text_editor>
Renders a rich text editor.
| Attr | Type | Default | Values / notes |
|---|---|---|---|
id |
:string |
nil |
|
name |
:string |
nil |
|
value |
:string |
nil |
|
field |
{:struct, Phoenix.HTML.FormField} |
nil |
|
label |
:string |
nil |
|
help |
:string |
nil |
|
errors |
:list |
[] |
|
placeholder |
:string |
nil |
|
toolbar |
:list |
[["bold", "italic", "underline", "strike"], ["blockquote", "code-block"], ["header-1", "header-2"], ["list-ordered", "list-bullet"], ["script-sub", "script-super"], ["indent-minus1", "indent-plus1"], ["direction-rtl"], ["size"], ["header"], ["color", "background"], ["font"], ["align"], ["clean"]] |
|
filled |
:boolean |
false |
|
content_class |
:any |
nil |
|
link_label |
:string |
"Enter link:" |
|
tool_labels |
:map |
%{} |
|
on_image |
:string |
nil |
|
images |
:boolean |
false |
|
image_label |
:string |
"Image URL:" |
|
image_alt_label |
:string |
"Description" |
|
image_save_label |
:string |
"Insert" |
|
save_label |
:string |
"Save" |
|
disabled |
:boolean |
false |
|
on_change |
:string |
nil |
|
debounce |
:integer |
300 |
|
target |
:any |
nil |
|
variant |
:string |
"default" |
default, comment |
density |
:string |
"comfortable" |
comfortable, compact - compact is the canvas frame: 12px radius, 28px toolbar buttons with small icons, a 90px text area with 12/14px padding and 14px type. |
loop |
:boolean |
false |
The canvas demo animation: the toolbar buttons light up in turn (1.2s apart, every 6s). |
slash |
:boolean |
false |
|
slash_items |
:list |
[%{label: "Text", key: "paragraph", hint: "Plain paragraph", icon: "¶"}, %{label: "Heading 1", key: "h1", hint: "Big section title", icon: "H1"}, %{label: "Heading 2", key: "h2", hint: "Medium section title", icon: "H2"}, %{label: "Bulleted list", key: "bullet", hint: "A simple list", icon: "•"}, %{label: "Numbered list", key: "ordered", hint: "A list with order", icon: "1."}, %{label: "Quote", key: "quote", hint: "Highlight a passage", icon: "❝"}, %{label: "Code block", key: "code", hint: "Monospaced text", icon: "</>"}, %{label: "Divider", key: "divider", hint: "A horizontal rule", icon: "—"}] |
|
on_slash |
:string |
nil |
|
slash_title |
:string |
"Insert" |
|
variables |
:list |
[] |
|
variable_label |
:string |
"Variable" |
|
variable_title |
:string |
"Insert variable" |
|
mentions |
:list |
[] |
|
mention_title |
:string |
"Mention someone" |
|
mention_button |
:boolean |
true |
|
mention_label |
:string |
"Mention" |
|
on_ai |
:string |
nil |
|
on_submit |
:string |
nil |
|
submit_label |
:string |
"Comment" |
|
submit_key |
:any |
"Ctrl ↵" |
|
submit_hint |
:string |
nil |
Text after the shortcut ("to send"). |
bar |
:boolean |
true |
|
clear_on_submit |
:boolean |
true |
|
footer |
:boolean |
false |
|
hint |
:string |
nil |
|
words_label |
:string |
"words" |
|
class |
:any |
nil |
Any other HTML/phx attribute goes to the root element.
Slots:
<:actions>- The buttons of a comment's bar, before the submit button (attach...).<:ai>- The content of a button at the end of the toolbar that asks the assistant.<:attachments>- What a comment carries (files as chips), between the text and the bar.
<.text_editor_content>
Shows saved rich text, read-only, in the editor's type. value is escaped unless it is already
marked safe ({:safe, html} / Phoenix.HTML.raw/1): pass safe HTML only after sanitize/2.
The inner block wins.
| Attr | Type | Default | Values / notes |
|---|---|---|---|
value |
:any |
nil |
|
class |
:any |
nil |
Any other HTML/phx attribute goes to the root element.
Slots:
<:inner_block>
<.rich_text_editor>
Same as text_editor/1 (same attributes and slots), under the name the design vitrine uses.
| Attr | Type | Default | Values / notes |
|---|---|---|---|
id |
:string |
nil |
|
name |
:string |
nil |
|
value |
:string |
nil |
|
field |
{:struct, Phoenix.HTML.FormField} |
nil |
|
label |
:string |
nil |
|
help |
:string |
nil |
|
errors |
:list |
[] |
|
placeholder |
:string |
nil |
|
toolbar |
:list |
[["bold", "italic", "underline", "strike"], ["blockquote", "code-block"], ["header-1", "header-2"], ["list-ordered", "list-bullet"], ["script-sub", "script-super"], ["indent-minus1", "indent-plus1"], ["direction-rtl"], ["size"], ["header"], ["color", "background"], ["font"], ["align"], ["clean"]] |
|
filled |
:boolean |
false |
|
content_class |
:any |
nil |
|
link_label |
:string |
"Enter link:" |
|
tool_labels |
:map |
%{} |
|
on_image |
:string |
nil |
|
images |
:boolean |
false |
|
image_label |
:string |
"Image URL:" |
|
image_alt_label |
:string |
"Description" |
|
image_save_label |
:string |
"Insert" |
|
save_label |
:string |
"Save" |
|
disabled |
:boolean |
false |
|
on_change |
:string |
nil |
|
debounce |
:integer |
300 |
|
target |
:any |
nil |
|
variant |
:string |
"default" |
default, comment |
density |
:string |
"comfortable" |
comfortable, compact |
loop |
:boolean |
false |
|
slash |
:boolean |
false |
|
slash_items |
:list |
[%{label: "Text", key: "paragraph", hint: "Plain paragraph", icon: "¶"}, %{label: "Heading 1", key: "h1", hint: "Big section title", icon: "H1"}, %{label: "Heading 2", key: "h2", hint: "Medium section title", icon: "H2"}, %{label: "Bulleted list", key: "bullet", hint: "A simple list", icon: "•"}, %{label: "Numbered list", key: "ordered", hint: "A list with order", icon: "1."}, %{label: "Quote", key: "quote", hint: "Highlight a passage", icon: "❝"}, %{label: "Code block", key: "code", hint: "Monospaced text", icon: "</>"}, %{label: "Divider", key: "divider", hint: "A horizontal rule", icon: "—"}] |
|
on_slash |
:string |
nil |
|
slash_title |
:string |
"Insert" |
|
variables |
:list |
[] |
|
variable_label |
:string |
"Variable" |
|
variable_title |
:string |
"Insert variable" |
|
mentions |
:list |
[] |
|
mention_title |
:string |
"Mention someone" |
|
mention_button |
:boolean |
true |
|
mention_label |
:string |
"Mention" |
|
on_ai |
:string |
nil |
|
on_submit |
:string |
nil |
|
submit_label |
:string |
"Comment" |
|
submit_key |
:any |
"Ctrl ↵" |
|
submit_hint |
:string |
nil |
Text after the shortcut ("to send"). |
bar |
:boolean |
true |
|
clear_on_submit |
:boolean |
true |
|
footer |
:boolean |
false |
|
hint |
:string |
nil |
|
words_label |
:string |
"words" |
|
class |
:any |
nil |
Any other HTML/phx attribute goes to the root element.
Slots:
<:actions>- The buttons of a comment's bar, before the submit button (attach...).<:ai>- The content of a button at the end of the toolbar that asks the assistant.<:attachments>- What a comment carries (files as chips), between the text and the bar.
<.comment_editor>
Same as text_editor/1 (same attributes and slots), under the name the design vitrine uses.
| Attr | Type | Default | Values / notes |
|---|---|---|---|
id |
:string |
nil |
|
name |
:string |
nil |
|
value |
:string |
nil |
|
field |
{:struct, Phoenix.HTML.FormField} |
nil |
|
label |
:string |
nil |
|
help |
:string |
nil |
|
errors |
:list |
[] |
|
placeholder |
:string |
nil |
|
toolbar |
:list |
[["bold", "italic", "underline", "strike"], ["blockquote", "code-block"], ["header-1", "header-2"], ["list-ordered", "list-bullet"], ["script-sub", "script-super"], ["indent-minus1", "indent-plus1"], ["direction-rtl"], ["size"], ["header"], ["color", "background"], ["font"], ["align"], ["clean"]] |
|
filled |
:boolean |
false |
|
content_class |
:any |
nil |
|
link_label |
:string |
"Enter link:" |
|
tool_labels |
:map |
%{} |
|
on_image |
:string |
nil |
|
images |
:boolean |
false |
|
image_label |
:string |
"Image URL:" |
|
image_alt_label |
:string |
"Description" |
|
image_save_label |
:string |
"Insert" |
|
save_label |
:string |
"Save" |
|
disabled |
:boolean |
false |
|
on_change |
:string |
nil |
|
debounce |
:integer |
300 |
|
target |
:any |
nil |
|
variant |
:string |
"comment" |
default, comment |
density |
:string |
"comfortable" |
comfortable, compact |
loop |
:boolean |
false |
|
slash |
:boolean |
false |
|
slash_items |
:list |
[%{label: "Text", key: "paragraph", hint: "Plain paragraph", icon: "¶"}, %{label: "Heading 1", key: "h1", hint: "Big section title", icon: "H1"}, %{label: "Heading 2", key: "h2", hint: "Medium section title", icon: "H2"}, %{label: "Bulleted list", key: "bullet", hint: "A simple list", icon: "•"}, %{label: "Numbered list", key: "ordered", hint: "A list with order", icon: "1."}, %{label: "Quote", key: "quote", hint: "Highlight a passage", icon: "❝"}, %{label: "Code block", key: "code", hint: "Monospaced text", icon: "</>"}, %{label: "Divider", key: "divider", hint: "A horizontal rule", icon: "—"}] |
|
on_slash |
:string |
nil |
|
slash_title |
:string |
"Insert" |
|
variables |
:list |
[] |
|
variable_label |
:string |
"Variable" |
|
variable_title |
:string |
"Insert variable" |
|
mentions |
:list |
[] |
|
mention_title |
:string |
"Mention someone" |
|
mention_button |
:boolean |
true |
|
mention_label |
:string |
"Mention" |
|
on_ai |
:string |
nil |
|
on_submit |
:string |
nil |
|
submit_label |
:string |
"Comment" |
|
submit_key |
:any |
"Ctrl ↵" |
|
submit_hint |
:string |
nil |
Text after the shortcut ("to send"). |
bar |
:boolean |
true |
|
clear_on_submit |
:boolean |
true |
|
footer |
:boolean |
false |
|
hint |
:string |
nil |
|
words_label |
:string |
"words" |
|
class |
:any |
nil |
Any other HTML/phx attribute goes to the root element.
Slots:
<:actions>- The buttons of a comment's bar, before the submit button (attach...).<:ai>- The content of a button at the end of the toolbar that asks the assistant.<:attachments>- What a comment carries (files as chips), between the text and the bar.