Clipboard
Botão copiar (color × variant × size, icon_only, copied) + ClipboardInput
Copia um valor para a área de transferência e confirma no próprio botão (e por toast opcional).
Copiar → copiado
<div class="flex flex-wrap items-center gap-2.5"><span class="inline-grid *:[grid-area:1/1]"><span class="animate-[lu-sw-a_4s_ease-in-out_infinite]"><.clipboard id="clip-swap-a" value="00020126580014br.gov.bcb.pix" toast={nil} color="neutral" variant="outline" size="sm" icon>Copiar chave Pix</.clipboard></span><span class="opacity-0 animate-[lu-sw-b_4s_ease-in-out_infinite]"><.clipboard id="clip-swap-b" color="success" variant="soft" size="sm" copied icon copied_label="Copiado" toast={nil} /></span></span></div>
variant
<div class="flex flex-wrap items-center gap-2.5"><.clipboard id="clip-1" value="LDG-2026-1043" toast={nil} color="neutral" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-2" value="LDG-2026-1043" toast={nil} color="neutral" variant="glow" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-3" value="LDG-2026-1043" toast={nil} color="neutral" variant="outline" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-4" value="LDG-2026-1043" toast={nil} color="neutral" variant="soft" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-5" value="LDG-2026-1043" toast={nil} color="neutral" variant="bordered" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-6" value="LDG-2026-1043" toast={nil} color="neutral" variant="flat" size="sm" icon>Copiar</.clipboard></div>
color
<div class="flex flex-wrap items-center gap-2.5"><.clipboard id="clip-7" value="LDG-2026-1043" toast={nil} color="neutral" variant="soft" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-8" value="LDG-2026-1043" toast={nil} variant="soft" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-9" value="LDG-2026-1043" toast={nil} color="secondary" variant="soft" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-10" value="LDG-2026-1043" toast={nil} color="info" variant="soft" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-11" value="LDG-2026-1043" toast={nil} color="success" variant="soft" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-12" value="LDG-2026-1043" toast={nil} color="warning" variant="soft" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-13" value="LDG-2026-1043" toast={nil} color="error" variant="soft" size="sm" icon>Copiar</.clipboard></div>
size · icon_only · copied
<div class="flex flex-wrap items-center gap-2.5"><.clipboard id="clip-14" value="LDG-2026-1043" toast={nil} color="neutral" variant="outline" size="xs" icon>Copiar</.clipboard><.clipboard id="clip-15" value="LDG-2026-1043" toast={nil} color="neutral" variant="outline" size="sm" icon>Copiar</.clipboard><.clipboard id="clip-16" value="LDG-2026-1043" toast={nil} color="neutral" variant="outline" icon>Copiar</.clipboard><.clipboard id="clip-17" value="LDG-2026-1043" toast={nil} color="neutral" variant="outline" size="lg" icon>Copiar</.clipboard><.clipboard id="clip-18" value="LDG-2026-1043" toast={nil} color="neutral" variant="outline" size="xl" icon>Copiar</.clipboard><.clipboard id="clip-icon" value="LDG-2026-1043" toast={nil} color="neutral" variant="ghost" size="sm" icon_only aria-label="Copiar" /><.clipboard id="clip-copied" size="sm" copied icon copied_label="Copiado" toast={nil} /></div>
clipboard_input
<div style="max-width:460px"><.clipboard_input id="api-key" value="sk_live_51Hx…a9f2" field_label="Chave de API" leading_icon="key" label="Copiar" toast={nil} readonly /></div>
Experimente: copia e avisa com um toast
<div class="flex flex-wrap items-center gap-2.5"> <span class="rounded-md bg-sunken px-2 py-1 font-mono text-xs text-muted">00020126580014BR.GOV.BCB.PIX</span> <.clipboard id="clip-live" value="00020126580014BR.GOV.BCB.PIX" toast={nil} on_copy={show_toast("Chave Pix copiada", kind: "success", description: "Na área de transferência")} copied_label="Copiado" color="neutral" variant="outline" size="sm" icon>Copiar</.clipboard> <.toaster id="ledger-toaster" /> </div>
Uso
<.clipboard value="LDG-2026-1043" variant="soft" size="sm" /> <.clipboard from="#api-key" icon_only /> <.clipboard_input value={@api_key} label="Chave de API" />
Regras
- Confirme a cópia no botão (“Copiado”) e, se
toastestiver ligado, com um toast curto. fromcopia o valor de outro elemento;icon_onlyvira só o ícone comaria-label.
Referência da API
Todos os function components, atributos, valores e slots que este componente cobre.
Copy to clipboard: clipboard/1, a button that copies a text, and clipboard_input/1, a
field with a copy button joined to it.
<.clipboard id="copy-ref" value="LDG-2026-1043" icon>Copiar</.clipboard>
<.clipboard id="copy-cmd" from="#cmd" icon_only variant="ghost" aria-label="Copiar comando" />
<.clipboard_input id="api-key" value={@api_key} field_label="Chave de API" readonly />
The buttons are the button/1 of color, variant and size, styled only with Tailwind
utilities. The hook LedgerUI.Clipboard (priv/static/ledger_ui/hooks/clipboard.js) does the
copy (navigator.clipboard, with a execCommand fallback), then for two seconds:
- turns the button into the copied state (
successcolour,softvariant,data-copied; the class list comes fromdata-lu-copied-class) and showscopied_labelin place of the label ([data-part=clipboard-label]) when given; - dispatches
ledger:toaston the page's toaster (windowif there is none) with%{message, kind}(kindis"success"or"error") when atoastis set. Passtoast={nil}for none; - runs
on_copy: an event name (pushed with%{"id" => id}, totargetif given) or a%JS{}.
value is the text to copy; from is a selector whose field value (or text) is copied instead.
copied renders the button already in the copied state.
<.clipboard>
| Attr | Type | Default | Values / notes |
|---|---|---|---|
id (required) |
:string |
Needed by the hook. | |
value |
:string |
nil |
The text to copy. |
from |
:string |
nil |
Selector of the field or element whose text is copied. |
locale |
:string |
"en" |
en, pt_BR |
toast |
:any |
:default |
Shown after a copy; nil or "" for none. By default the locale's text. |
error_toast |
:string |
nil |
|
copied |
:boolean |
false |
Renders the copied state. |
on_copy |
:any |
nil |
An event name or a %JS{}. |
target |
:any |
nil |
|
copied_label |
:string |
nil |
|
icon |
:boolean |
false |
A copy icon before the text (a check while copied). |
icon_only |
:boolean |
false |
Just the icon; give it an aria-label. |
color |
:string |
"primary" |
neutral, primary, secondary, info, success, warning, error |
variant |
:string |
"solid" |
solid, glow, outline, soft, bordered, flat, ghost |
size |
:string |
"md" |
xs, sm, md, lg, xl |
class |
:any |
nil |
Any other HTML/phx attribute goes to the root element.
Slots:
<:inner_block>
<.clipboard_input>
| Attr | Type | Default | Values / notes |
|---|---|---|---|
id (required) |
:string |
The id of the input; the button is <id>-copy. |
|
name |
:string |
nil |
|
value |
:string |
nil |
|
placeholder |
:string |
nil |
|
label |
:string |
nil |
The button's text; by default the locale's. |
field_label |
:string |
nil |
The label above the field. |
leading_icon |
:string |
nil |
An icon at the start of the field. |
copied_label |
:string |
nil |
|
icon |
:boolean |
true |
A copy icon before the label. |
locale |
:string |
"en" |
en, pt_BR |
toast |
:any |
:default |
|
error_toast |
:string |
nil |
|
on_copy |
:any |
nil |
|
target |
:any |
nil |
|
class |
:any |
nil |
Merged into the wrapper. |
Any other HTML/phx attribute goes to the root element, including readonly, disabled, autocomplete, form, phx-debounce.