BreadcrumbBar¶

Path trail; model items raise itemClicked.

import QWinUI3.Extras · src/extras/QWinUI3/Extras/BreadcrumbBar.qml

Category: Navigation · Library: v2.80

Gallery: BreadcrumbBar — src/gallery/pages/BreadcrumbBarPage.qml

Extends Control.

Example¶

BreadcrumbBar {
    id: breadcrumbBar
    model: [{ title: "Home" }, { title: "Docs" }]
    onItemClicked: (index) => navigate(index)
}

// --- API ---
// signals: onItemClicked, onItemInvoked
// methods: crumbTitle(data), crumbIcon(data), isCurrent(index), isClickable(entry)
// breadcrumbBar.crumbTitle(data)
// breadcrumbBar.crumbIcon(data)
// breadcrumbBar.isCurrent(index)
// breadcrumbBar.isClickable(entry)

Notes¶

Path trail from model [{ title, icon? }]; itemClicked(index); overflow collapses.

API¶

Properties¶

Name	Type	Description
`model`	`var`	Data model / item list for this control
`currentIndex`	`int`	Selected index
`selectedItem`	`var`	Currently selected model item (WinUI SelectedItem)
`maxVisibleItems`	`int`	Collapse middle crumbs when count exceeds this (0 = show all)
`maxItems`	`alias`	WinUI MaxItems alias
`lastItemClickable`	`bool`	WinUI: current/last crumb is usually non-interactive
`separatorSymbol`	`var`	Breadcrumb separator FluentIcons symbol
`separatorGlyph`	`string`	Breadcrumb separator glyph string
`accessibleName`	`string`	Override list name when multiple trails share a page (2.29)
`announceChanges`	`bool`	Qt 6.8+ live region for crumb activation (2.29)
`effectiveSeparatorGlyph`	`string`	Resolved separator glyph
`visibleModel`	`var`	Visible (non-overflow) crumbs
`overflowModel`	`var`	Overflow crumb items

Signals¶

Signature	Description
`itemClicked(int index)`	Emitted when an item is clicked
`itemInvoked(int index)`	WinUI ItemInvoked

Methods¶

Signature	Description
`crumbTitle(data)`	Title text for a breadcrumb item
`crumbIcon(data)`	Icon for a breadcrumb item
`isCurrent(index)`	True when this crumb is the current page
`modelFromNavigationPath(path)`	Map NavigationView.breadcrumbPathForKey() to a BreadcrumbBar model (2.23)
`isClickable(entry)`	Emit clicked when activated

Inherited from `Control`¶

Also available (base type / Qt Quick Controls):

padding
font
background / contentItem

Generated from module sources by scripts/generate_component_docs.py — do not edit by hand.