PUI. Breadcrumb
(pui v1.0.0)
Copy Markdown
Accessible breadcrumb navigation primitives.
Breadcrumbs describe the current location without owning routing. Links accept
normal Phoenix href, navigate, and patch attributes, so the host
application controls navigation and URL generation.
Example
<.breadcrumb>
<.breadcrumb_list>
<.breadcrumb_item>
<.breadcrumb_link navigate={~p"/projects"}>Projects</.breadcrumb_link>
</.breadcrumb_item>
<.breadcrumb_separator />
<.breadcrumb_item>
<.breadcrumb_page>Website refresh</.breadcrumb_page>
</.breadcrumb_item>
</.breadcrumb_list>
</.breadcrumb>Components
| Component | Attributes | Description |
|---|---|---|
breadcrumb/1 | aria_label, class, global attributes | Navigation landmark |
breadcrumb_list/1 | class | Ordered breadcrumb list |
breadcrumb_item/1 | class | One breadcrumb item |
breadcrumb_link/1 | class, href, navigate, patch | Navigable ancestor |
breadcrumb_page/1 | class | Current page with aria-current |
breadcrumb_separator/1 | class | Customizable separator |
breadcrumb_ellipsis/1 | class | Collapsed breadcrumb indicator |
Application-specific separators can be supplied through the separator's
inner_block slot. The default uses the provider-agnostic :chevron_right
icon token.
Summary
Functions
Attributes
aria_label(:string) - Defaults to"Breadcrumb".class(:string) - Defaults to"".- Global attributes are accepted.
Slots
inner_block(required)
Attributes
class(:string) - Defaults to"".- Global attributes are accepted.
Attributes
class(:string) - Defaults to"".- Global attributes are accepted.
Slots
inner_block(required)
Attributes
class(:string) - Defaults to"".- Global attributes are accepted. Supports all globals plus:
["href", "navigate", "patch", "replace", "method", "target", "rel", "download", "hreflang", "referrerpolicy"].
Slots
inner_block(required)
Attributes
class(:string) - Defaults to"".- Global attributes are accepted.
Slots
inner_block(required)
Attributes
class(:string) - Defaults to"font-normal text-foreground".- Global attributes are accepted.
Slots
inner_block(required)
Attributes
class(:string) - Defaults to"[&>svg]:size-3.5".- Global attributes are accepted.
Slots
inner_block