Breadcrumb Blazor API
NameTypeDefaultDescription
AddNewItemboolfalseEnables or disables the "Add new item" (+) button.
AllowDragboolfalseEnables or disables the dragging of breadcrumb items.
AllowDropboolfalseEnables or disables the dropping of dragged breadcrumb items.
CloseButtonsboolfalseShow/Hide the close button of breadcrumb items.
DataSourceIEnumerable<object>[]Determines the data source to load breadcrumb items from. The Array should contain objects. Each object defines a single breadcrumb item.
DisabledboolfalseEnables or disables the Breadcrumb.
ItemTemplateobjectN/ASets or gets the template of breadcrumb items. The value of this property can be the id of an HTMLTemplateElement or the HTMLTemplateElement itself. If set to null, no template is applied.
Localestring"en"Sets or gets the language. Used in conjunction with the property messages.
MessagesobjectN/ASets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
MinimizeWidthintN/ADetermines the minimum width of the Breadcrumb at which it will switch from normal to minimized mode. If set to null, the Breadcrumb does not minimize automatically.
UnfocusableboolfalseIf is set to true, the element cannot be focused.
NameTypeArgumentsDescription
AddItemvoidobject itemDetailsAdds an item.Args: object itemDetails - An Object with the fields "index", "label", and "value".
GetDataSourceAsync()Task<IEnumerable<object>>'N/A'Gets the &quot;DataSource&quot; property as Task&lt;IEnumerable&lt;object&gt;&gt;.
MaximizevoidN/ARestores the Breadcrumb from minimized state back to normal.
MinimizevoidN/AMinimizes the Breadcrumb.
Refreshvoid'N/A'Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements.
RemoveItemvoidobject itemRemoves an item.Args: object item - The item to remove.
Rendervoid'N/A'Re-renders the Blazor Component. This method will make a full re-render.
StateHasChangedvoid'N/A'Refreshes the state and Re-renders the Blazor Component, if necessary.
NameTypeDescriptionEvent Detail
OnCloseEventCallback<Event>This event is triggered when a Breadcrumb item is closed.dynamic item- The item that has been closed.
Closedevent BreadcrumbClosedEventHandlerThis event is triggered when a Breadcrumb item is closed.BreadcrumbClosedEventArgs
OnClosingEventCallback<Event>This event is triggered when a Breadcrumb item is about to be closed. The closing operation can be canceled by calling <code>event.preventDefault()</code> in the event handler function.dynamic item- The item that is going to be closed.
Closingevent BreadcrumbClosingEventHandlerThis event is triggered when a Breadcrumb item is about to be closed. The closing operation can be canceled by calling <code>event.preventDefault()</code> in the event handler function.BreadcrumbClosingEventArgs
OnDragEndEventCallback<Event>This event is triggered when a Breadcrumb item is dropped.N/A
DragEndedevent BreadcrumbDragEndedEventHandlerThis event is triggered when a Breadcrumb item is dropped.BreadcrumbDragEndedEventArgs
OnDraggingEventCallback<Event>This event is triggered when a Breadcrumb item is being dragged.dynamic item- The item that is being dragged., dynamic originalEvent- The original event that initiates the dragging operation., dynamic target- The original target.
Draggingevent BreadcrumbDraggingEventHandlerThis event is triggered when a Breadcrumb item is being dragged.BreadcrumbDraggingEventArgs
OnAddNewItemEventCallback<Event>This event is triggered when the "Add new item" (+) button is clicked.N/A
AddNewItemedevent BreadcrumbAddNewItemedEventHandlerThis event is triggered when the "Add new item" (+) button is clicked.BreadcrumbAddNewItemedEventArgs