V Vaylan UI
Feedback

Alert

Communicate important information and outcomes.

Preview

Display-only component. It does not own an interaction model.

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.

AttributeTypeRequiredDefault 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
SlotRequiredSlot 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

Behavioral tests

These automated checks are applied to this component by the package and documentation test suites.

  • ExUnit

    Semantic alert variants

    Renders semantic alert colors while preserving icon, message, and action content.

    test/vaylan_ui/components_test.exs
  • Docs

    Preview behavior contract

    Classified as display. Display-only component. It does not own an interaction model.

    examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs
  • Docs

    Stable public component page

    Renders the component name, example, API contract, accepted values, and keyboard and accessibility guidance at its stable URL.

    examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs