Button
Start actions with consistent emphasis, sizing, and loading states.
Preview
Activate the example controls to see a local confirmation.
Example
<.button color={:primary}>Save changes</.button>
API contract
button/1
uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.
| Attribute | Type | Required | Default | Accepted values |
|---|---|---|---|---|
type |
:string |
No | "button" |
["button", "submit", "reset"] |
color |
:atom |
No | nil |
[nil, :neutral, :primary, :secondary, :accent, :info, :success, :warning, :error] |
variant |
:atom |
No | nil |
[nil, :outline, :dash, :soft, :ghost, :link] |
size |
:atom |
No | nil |
[:xs, :sm, :md, :lg, :xl, nil] |
shape |
:atom |
No | nil |
[nil, :wide, :block, :square, :circle] |
loading |
:boolean |
No | false |
Any value matching the declared type |
disabled |
:boolean |
No | false |
Any value matching the declared type |
class |
:any |
No | nil |
Any value matching the declared type |
rest |
:global |
No | — |
global includes ["form", "name", "value", "phx-click", "phx-disable-with"] |
| Slot | Required | Slot attributes |
|---|---|---|
leading |
No | No slot attributes |
inner_block |
Yes | No slot attributes |
trailing |
No | No slot attributes |
States and behavior
Current, disabled, loading, or active state is exposed where the component supports it.
Keyboard and accessibility
Behavioral tests
These automated checks are applied to this component by the package and documentation test suites.
-
ExUnit
Action states
Checks neutral defaults, variants, disabled and loading behavior, aria-busy, and the named loading indicator.
test/vaylan_ui/components_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 action. Activate the example controls to see a local confirmation.
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