Alert
Communicate important information and outcomes.
Preview
The latest documentation is available.
Your changes were saved.
Check these values before continuing.
Example
<.alert color={:info} variant={:soft}>Your report is being prepared.</.alert>
API contract
alert/1 uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.
| Attribute | Type | Required | Default | Accepted values |
|---|---|---|---|---|
color |
:atom |
No | nil |
[nil, :info, :success, :warning, :error] |
variant |
:atom |
No | nil |
[nil, :outline, :dash, :soft] |
class |
:any |
No | nil |
Any value matching the declared type |
rest |
:global |
No | — |
Any value matching the declared type |
| Slot | Required | Slot attributes |
|---|---|---|
icon |
No | No slot attributes |
inner_block |
Yes | No slot attributes |
actions |
No | No slot attributes |
States and behavior
Semantic text accompanies visual treatment so status is not conveyed through color or motion alone.
Keyboard and accessibility
The component itself does not add a keyboard interaction. Any slotted action must remain a labelled native control.