Filter
Focus a collection on one category, then clear it in one step.
Preview
Change the example value; the preview reports the current state.
Example
<.filter name="status"><:option label="Active" value="active" /></.filter>
API contract
filter/1
uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.
| Attribute | Type | Required | Default | Accepted values |
|---|---|---|---|---|
name |
:string |
Yes | — |
Any value matching the declared type |
reset_label |
:string |
No | "Clear filter" |
Any value matching the declared type |
class |
:any |
No | nil |
Any value matching the declared type |
rest |
:global |
No | — |
Any value matching the declared type |
| Slot | Required | Slot attributes |
|---|---|---|
option |
Yes | label: :string required, value: :string required |
States and behavior
Default and caller-supplied variants preserve semantic daisyUI colors and additive classes.
Keyboard and accessibility
Behavioral tests
These automated checks are applied to this component by the package and documentation test suites.
-
ExUnit
Filter option group
Preserves the shared native field name and renders each supplied option with its label and value.
test/vaylan_ui/catalog_test.exs -
Docs
Preview behavior contract
Classified as input. Change the example value; the preview reports the current state.
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