Breadcrumbs
Show a compact trail back through the current hierarchy.
Preview
Choose an example destination. The preview updates locally without leaving this page.
Example
<.breadcrumbs><:item label="Home" href="/" /><:item label="Projects" current /></.breadcrumbs>
API contract
breadcrumbs/1
uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.
| Attribute | Type | Required | Default | Accepted values |
|---|---|---|---|---|
label |
:string |
No | "Breadcrumb" |
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 |
|---|---|---|
item |
Yes | label: :string required, href: :string, navigate: :string, patch: :string, current: :boolean |
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
Current breadcrumb state
Marks the current destination with aria-current while retaining native links for earlier items.
test/vaylan_ui/components_test.exs -
Docs
Preview behavior contract
Classified as navigation. Choose an example destination. The preview updates locally without leaving this page.
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