Breadcrumbs

(part of package 'Bootstrap Extra Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

Breadcrumb is a navigation component that displays a series of links representing the current navigation path. It is typically used to help users navigate hierarchical structures within an application.

This is a reference page; many components have detailed usage guides here.

Properties

autoRemoveWhenClicked

When true, a breadcrumb item is automatically removed from the trail after it is clicked. Type: Boolean Default Value: true

---

breadcrumbs

An array of breadcrumb items representing the entire breadcrumb trail. Type: Array<CustomType<bootstrapextracomponents-breadcrumbs.crumb>>

---

crumbStyleClass

CSS style classes applied to individual breadcrumb items. Type: Styleclass

---

lastCrumbStyleClass

CSS style classes applied to the last breadcrumb item in the trail. Type: Styleclass

---

location

The position of the breadcrumb component on the form. Type: Point

---

styleClass

Additional CSS style classes to be applied to the breadcrumb container. Type: Styleclass

---

visible

Flag indicating whether the breadcrumb component is visible. Type: Visible

---

Events

onCrumbClicked(event,crumb,index)

Called whenever a breadcrumb item is clicked with the JSEvent and the item clicked on.

Parameters:

• {JSEvent} event The event object containing details about the click event e.g. target element, mouse coordinates

• {CustomType<bootstrapextracomponents-breadcrumbs.crumb>} crumb The breadcrumb item that was clicked

• {Number} index The index of the clicked breadcrumb item in the items array

---

API

addCrumb(crumb)

Adds a crumb at the end

Parameters:

• {CustomType<bootstrapextracomponents-breadcrumbs.crumb>} crumb A breadcrumb object to be added at the end of the breadcrumb trail.

---

removeCrumbsAfter(index)

Removes all crumbs after the given index

Parameters:

• {Number} index The 0-based index after which all breadcrumbs will be removed.

---

removeLastCrumb()

Removes the last crumb

---

setCrumbs(crumbs)

Sets all crumbs

Parameters:

• {Array<CustomType<bootstrapextracomponents-breadcrumbs.crumb>>} crumbs An array of breadcrumb objects to set as the entire breadcrumb trail.

---

Types

crumb

Represents an individual breadcrumb item. scripting type: CustomType<bootstrapextracomponents-breadcrumbs.crumb>

• crumbId

  • Unique identifier for the breadcrumb item.

  • Type: string

• displayName

  • The display name or label of the breadcrumb item.

  • Type: tagstring

---