Skip to content

Breadcrumb ​

Breadcrumb trail showing the path to the current page — a row of crumbs separated by chevrons. Non-last crumbs are accent-colored and clickable when onNavigate is set; the last crumb is the current page.

Import ​

kotlin
import io.github.heartcoolman.prism.ui.PrismBreadcrumb
import io.github.heartcoolman.prism.ui.PrismBreadcrumbItem

Basic usage ​

kotlin
PrismBreadcrumb(
    items = listOf(
        PrismBreadcrumbItem("Home"),
        PrismBreadcrumbItem("Library"),
        PrismBreadcrumbItem("Item"),
    ),
    onNavigate = { index -> /* navigate to items[index] */ },
)

Static trail ​

Omit onNavigate to render the crumbs as plain text (non-clickable).

kotlin
PrismBreadcrumb(
    items = listOf(
        PrismBreadcrumbItem("Home"),
        PrismBreadcrumbItem("Settings"),
    ),
)

API ​

ParameterTypeDefaultDescription
itemsList<PrismBreadcrumbItem>—Ordered trail from root to current page; the last item is the current page.
modifierModifierModifierLayout modifier for the row.
onNavigate((Int) -> Unit)?nullWhen set, non-last crumbs become clickable and report the tapped index.

PrismBreadcrumbItem ​

FieldTypeDescription
labelStringVisible label for the crumb.

Released under the MIT License.