Select
Lets people choose one option from a list in a dropdown.
Default
label
shows in the trigger until an option is chosen.
Xcode
Gradle
Bazel
Mix (Elixir)
Cargo (Rust)
<.select id="select-default" label="Select build system" name="build_system">
<:item value="xcode" label="Xcode" />
<:item value="gradle" label="Gradle" />
<:item value="bazel" label="Bazel" />
<:item value="mix" label="Mix (Elixir)" />
<:item value="cargo" label="Cargo (Rust)" />
</.select>
Selected value
With
value
, the trigger shows the matching item's label.
macOS and Linux
macOS
Linux
<.select id="select-selected" label="Select platforms" name="platforms" value="all">
<:item value="all" label="macOS and Linux" />
<:item value="macos" label="macOS" />
<:item value="linux" label="Linux" />
</.select>
With icons
An
icon
on each item shows next to its label in the menu, and in the trigger for the item matching
value
.
tuist
acme-mobile
marek
<.select id="select-icons" label="Select organization" name="account_id" value="tuist">
<:item value="tuist" label="tuist" icon="building" />
<:item value="acme-mobile" label="acme-mobile" icon="building" />
<:item value="marek" label="marek" icon="user" />
</.select>
With hint
Europe (Frankfurt)
US East (Virginia)
Asia Pacific (Singapore)
<.select
id="select-hint"
label="Select a region"
name="region"
hint="Cache artifacts are stored in this region."
>
<:item value="eu-central" label="Europe (Frankfurt)" />
<:item value="us-east" label="US East (Virginia)" />
<:item value="ap-southeast" label="Asia Pacific (Singapore)" />
</.select>
Disabled
Xcode
Gradle
<.select
id="select-disabled"
label="Select build system"
name="build_system"
value="xcode"
disabled
>
<:item value="xcode" label="Xcode" />
<:item value="gradle" label="Gradle" />
</.select>
Guidelines
-
labelis the text in the trigger, shown until an option is chosen. Write it as a prompt, such as Select a country, and title the field with a label component above the select. -
Pass
nameto submit the choice with a form. The select renders a hidden native select with that name. -
Use
on_value_changeto react to a choice right away. The event receives the chosen values as a list undervalue. -
Give every
:itemboth avalueand alabel. The menu and the trigger show thelabel, and the form submits thevalue. -
The list of items and the choice live in the browser once the select mounts. When the items change on the server, change the select's
idso it remounts.
API reference
<.select>
| Attribute | Type | Default | Description |
|---|---|---|---|
|
disabled
|
boolean
|
nil
|
Whether the dropdown is disabled
|
|
field
|
Phoenix.HTML.FormField
|
–
|
A Phoenix form field
|
|
hint
|
string
|
nil
|
Hint text for the dropdown
|
|
id
Required
|
string
|
–
|
Unique identifier for the dropdown component
|
|
label
Required
|
string
|
–
|
Main text displayed in the dropdown trigger
|
|
name
|
string
|
–
|
The name attribute for the select input
|
|
on_value_change
|
string
|
nil
|
Event handler for when an option is selected
|
|
value
|
string
|
nil
|
The currently selected value
|
| Slot | Description |
|---|---|
|
inner_block
|
Content to be rendered inside the dropdown menu
|
|
:item
|
Attributes:
iconlabelvalue
|