V Vaylan UI
Forms

Radio group

Choose one option from a labelled, keyboard-operable group.

Preview

Plan

Example

<.radio_group field={@form[:role]} label="Role" options={[{"Admin", "admin"}, {"Editor", "editor"}]} />

API contract

radio_group/1 uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.

AttributeTypeRequiredDefaultAccepted values
field {:struct, Phoenix.HTML.FormField} No nil Any value matching the declared type
id :string No nil Any value matching the declared type
name :string No nil Any value matching the declared type
label :string Yes — Any value matching the declared type
value :any No nil Any value matching the declared type
options :list Yes — Any value matching the declared type
description :string No nil Any value matching the declared type
errors :list No [] Any value matching the declared type
color :atom No nil [nil, :neutral, :primary, :secondary, :accent, :info, :success, :warning, :error]
size :atom No nil [:xs, :sm, :md, :lg, :xl, nil]
inline :boolean No false Any value matching the declared type
class :any No nil Any value matching the declared type
rest :global No — global includes ["disabled", "form", "required"]

States and behavior

Default, disabled, described, and server-invalid states are supported. Text-like fields also pass applicable native read-only and required attributes.

Keyboard and accessibility