Breadcrumbs

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

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

Properties

autoRemoveWhenClicked

Type: Boolean Default Value: true

---

breadcrumbs

Type: Array<CustomType<bootstrapextracomponents-breadcrumbs.crumb>>

---

crumbStyleClass

Type: Styleclass

---

lastCrumbStyleClass

Type: Styleclass

---

location

Type: Point

---

styleClass

Type: Styleclass

---

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

• {CustomType<bootstrapextracomponents-breadcrumbs.crumb>} crumb

• {Number} index

---

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<crumb>} crumbs An array of breadcrumb objects to set as the entire breadcrumb trail.

---

Types

crumb

scripting type: CustomType<bootstrapextracomponents-breadcrumbs.crumb>

• crumbId

  • Type: string

• displayName

  • Type: tagstring

---