Skip to main content
A breadcrumb navigation component that displays a hierarchical trail of links, helping users understand their current location within the application.

Constructor

JBreadcrumb()
constructor
Creates a new breadcrumb component with default settings.

Methods

addItem

addItem(String text, Runnable action)
JBreadcrumb
Adds a clickable breadcrumb item.
addItem(String text, Node icon, Runnable action)
JBreadcrumb
Adds a clickable breadcrumb item with an icon.
addItem(String text)
JBreadcrumb
Adds the current (last) breadcrumb item without an action.
addItem(String text, Node icon)
JBreadcrumb
Adds the current (last) breadcrumb item with an icon.

Configuration

setSeparator(String sep)
JBreadcrumb
Changes the separator character between breadcrumb items.
setActiveColor(String color)
JBreadcrumb
Changes the color of the active (current) breadcrumb item.
clear()
JBreadcrumb
Removes all breadcrumb items.
setPath(String... paths)
JBreadcrumb
Sets multiple breadcrumb items at once. All items except the last are navigable.

Usage Example

JBreadcrumb bc = new JBreadcrumb();
bc.addItem("Home", () -> navigate("home"));
bc.addItem("Users", () -> navigate("users"));
bc.addItem("Profile"); // Current page (no action)

// With custom separator
bc.setSeparator(">");

// With active color
bc.setActiveColor("primary");

Style Classes

  • .j-breadcrumb - Main container
  • .j-breadcrumb-separator - Separator element
  • .j-breadcrumb-item - Normal (clickable) item
  • .j-breadcrumb-item-active - Active (current) item
  • .j-breadcrumb-link - Link label
  • .j-breadcrumb-active - Active label
  • .j-breadcrumb-color-{variant} - Color variant classes

Build docs developers (and LLMs) love