Badge
Show short roles, labels, and data states.
Preview
Display-only component. It does not own an interaction model.
Example
<.badge color={:success} variant={:soft}>Ready</.badge>
API contract
badge/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, :neutral, :primary, :secondary, :accent, :info, :success, :warning, :error] |
variant |
:atom |
No | nil |
[nil, :outline, :dash, :soft, :ghost] |
size |
:atom |
No | :md |
[:xs, :sm, :md, :lg, :xl] |
class |
:any |
No | nil |
Any value matching the declared type |
rest |
:global |
No | — |
Any value matching the declared type |
| Slot | Required | Slot attributes |
|---|---|---|
inner_block |
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
Badge variants
Renders severity, size, caller classes, and visible badge content.
test/vaylan_ui/primereact_adapted_contracts_test.exs -
Adapted
PrimeReact scenario adaptation
Applies independently written Phoenix assertions derived from the documented PrimeReact 10.9.9 behavior group.
test/vaylan_ui/primereact_adapted_contracts_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