Skip to main content

QCustomBreadcrumbs

QCustomBreadcrumbs

A clickable path navigation.

Home / Section / Page ... - all but the last segment are clickable links; the last is the current location. Tokenized.

At a glance​

TierFree (GPLv3)
Importfrom Custom_Widgets.QCustomBreadcrumbs import QCustomBreadcrumbs
Qt DesignerYes — drag it from the palette

Quick start​

from Custom_Widgets.QCustomBreadcrumbs import QCustomBreadcrumbs

widget = QCustomBreadcrumbs()
widget.setItems([("Home", "/"), ("Projects", "/projects"),
("Atlas", "/projects/atlas"),
("Settings", "/projects/atlas/settings")])

That is the exact code behind the screenshot above.

Dark theme​

Colours come from the design tokens, so the widget follows the app theme with no extra work.

QCustomBreadcrumbs in dark theme

Properties​

Every property below is settable in code and in Qt Designer.

PropertyTypeDefault
separatorstring—

Signals​

Signal
itemClicked(int,PyObject)

Methods​

MethodDescription
itemClicked(...)Item clicked.
items()Items.
separator(*args, **kwargs)Separator.
setItems(items)Set the trail. Each item is a string, (label, data) pair, or a dict

Theming​

Colours come from the design tokens, so they follow the active theme. Roles used: accent, on-surface, on-surface-muted, primary-hover.

See Design tokens.

QCustomCommandPalette · QCustomDrawer · QCustomHamburgerMenu · QCustomHeaderNav · QCustomMenu · QCustomPagination · QCustomSidebar · QCustomSidebarButton