BreadcrumbModel API in JavaScript Breadcrumb API control

Interface for a class Breadcrumb

Properties

beforeItemRender

EmitType<BreadcrumbBeforeItemRenderEventArgs>

Triggers while rendering each breadcrumb item.

created

EmitType<Event>

Triggers once the component rendering is completed.

itemClick

EmitType<BreadcrumbClickEventArgs>

Triggers while clicking the breadcrumb item.

activeItem

string

Specifies the Url of the active Breadcrumb item.

cssClass

string

Defines class/multiple classes separated by a space in the Breadcrumb element.

disabled

boolean

Enable or disable the breadcrumb, when set to true, the breadcrumb will be disabled.

enableActiveItemNavigation

boolean

Enable or disable the active item navigation, when set to true, active item will be navigable.

enableNavigation

boolean

Enable or disable the item’s navigation, when set to false, each item navigation will be prevented.

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

enableRtl

boolean

Enable or disable rendering component in right to left direction.

itemTemplate

string | Function

Specifies the template for Breadcrumb item.

items

BreadcrumbItemModel[]

Defines the list of Breadcrumb items.

maxItems

number

Specifies an integer to enable overflow behavior when the Breadcrumb items count exceeds and it is based on the overflowMode property.

overflowMode

string | BreadcrumbOverflowMode

Specifies the overflow mode of the Breadcrumb item when it exceeds maxItems count. The possible values are,

• Default: Specified maxItems count will be visible and the remaining items will be hidden. While clicking on the previous item, the hidden item will become visible.
• Collapsed: Only the first and last items will be visible, and the remaining items will be hidden in the collapsed icon. When the collapsed icon is clicked, all items become visible.
• Menu: Shows the number of breadcrumb items that can be accommodated within the container space, and creates a sub menu with the remaining items.
• Wrap: Wraps the items on multiple lines when the Breadcrumb’s width exceeds the container space.
• Scroll: Shows an HTML scroll bar when the Breadcrumb’s width exceeds the container space.
• None: Shows all the items on a single line.

separatorTemplate

string | Function

Specifies the separator template for Breadcrumb.

url

string

Defines the Url based on which the Breadcrumb items are generated.