Skip to content

BreadcrumbItem

Navigation item descriptor representing a step or crumb in a breadcrumb trail.

Overview

Overview and usage documentation.

Basic Usage

BreadcrumbItem item = new BreadcrumbItem("Dashboard");
item.enabled(true);
  • Breadcrumb: Interactive navigation trail widget displaying hierarchical breadcrumb items with customizable separators and selection handling.

API

Constructs an empty BreadcrumbItem.

Constructs a BreadcrumbItem with a RichText formatted label.

Parameter Type Description
text RichText The text label.

Constructs a BreadcrumbItem with a plain text label.

Parameter Type Description
text String The text label.

BreadcrumbItem::enabled()

Returns true if this item is interactive.

Returns boolean: True if enabled; false otherwise..

BreadcrumbItem::enabled(boolean)

Sets whether this item is interactive.

Parameter Type Description
enabled boolean Whether the feature or item is enabled.

Returns BreadcrumbItem: This instance for chaining..

BreadcrumbItem::richText()

Returns the RichText formatted label.

Returns RichText: The rich text representation..

BreadcrumbItem::richText(RichText)

Sets the RichText formatted label.

Parameter Type Description
text RichText The text label.

Returns BreadcrumbItem: This instance for chaining..

BreadcrumbItem::text()

Returns the plain text label.

Returns String: The plain text label string..

BreadcrumbItem::text(String)

Sets the plain text label.

Parameter Type Description
text String The text label.

Returns BreadcrumbItem: This instance for chaining..

BreadcrumbItem::value()

Returns the associated data payload or route string.

Returns String: The semantic identifier value..

BreadcrumbItem::value(String)

Sets the associated data payload or route string.

Parameter Type Description
value String The semantic value.

Returns BreadcrumbItem: This instance for chaining..