Breadcrumb - bit BlazorUI
Home Docs

Breadcrumb

Breadcrumbs should be used as a navigational aid in your app or site. They indicate the current page’s location within a hierarchy and help the user understand where they are in relation to the rest of that hierarchy. They also afford one-click access to higher levels of that hierarchy.

Notes

The BitBreadcrumb is a Multi-API component which can accept the list of Items in 3 different ways: BitBreadcrumbItem class, a custom Generic class, and BitBreadcrumbOption component.

Usage

Implementation

BitBreadcrumb parameters
Name
Type
Default value
Description
ClassField string Class Class HTML attribute for BreadList item.
ClassFieldSelector Expression<Func<TItem, object>>? null Class HTML attribute for BreadList item.
ChildContent RenderFragment? null The content of the BitBreadcrumb, that are BitBreadOption components.
DividerIconName string ChevronRight The divider icon name.
HrefField string Href URL to navigate to when this BreadList item is clicked. If provided, the BreadList will be rendered as a link.
HrefFieldSelector Expression<Func<TItem, object>>? null URL to navigate to when this BreadList item is clicked. If provided, the BreadList will be rendered as a link.
Items IList<TItem> new List<TItem>() Collection of breadcrumbs to render
IsSelectedField string IsSelected Display the item as a Selected item.
IsSelectedFieldSelector Expression<Func<TItem, bool>>? null Display the item as a Selected item.
IsEnabledField string IsEnabled Whether an item is enabled or not.
IsEnabledFieldSelector Expression<Func<TItem, bool>>? null Whether an item is enabled or not.
MaxDisplayedItems uint 0 The maximum number of breadcrumbs to display before coalescing. If not specified, all breadcrumbs will be rendered.
OverflowAriaLabel string? null Aria label for the overflow button.
OverflowIndex uint 0 Optional index where overflow items will be collapsed.
OverflowIconName string More The overflow icon name.
OnItemClick EventCallback<TItem> Callback for when the breadcrumb item clicked.
SelectedItemClass string? null The CSS class attribute for the selected item.
SelectedItemStyle string? null The style attribute for selected item.
StyleField string Style Style HTML attribute for BreadList item.
StyleFieldSelector Expression<Func<TItem, object>>? null Style HTML attribute for BreadList item.
TextField string Text Text to display in the BreadList item.
TextFieldSelector Expression<Func<TItem, object>>? null Text to display in the BreadList item.
BitComponentBase parameters
Name
Type
Default value
Description
AriaLabel string? null The aria-label of the control for the benefit of screen readers.
Class string? null Custom CSS class for the root element of the component.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Capture and render additional attributes in addition to the component's parameters.
Id string? null Custom id attribute for the root element. if null the UniqueId will be used instead.
IsEnabled bool true Whether or not the component is enabled.
Style string? null Custom CSS style for the root element of the component.
Visibility BitVisibility BitVisibility.Visible Whether the component is visible, hidden or collapsed.
BitComponentBase public members
Name
Type
Default value
Description
UniqueId Guid Guid.NewGuid() The readonly unique id of the root element. it will be assigned to a new Guid at component instance construction.
RootElement ElementReference The ElementReference of the root element.
BitBreadcrumbItem properties
Name
Type
Default value
Description
Text string? Text to display in the breadcrumb item.
Href string? URL to navigate to when this breadcrumb item is clicked. If provided, the breadcrumb will be rendered as a link.
Class string? CSS class attribute for breadcrumb item.
Style string? Style attribute for breadcrumb item.
IsSelected bool Display the item as the selected item.
IsEnabled bool true Whether an item is enabled or not.
BitBreadcrumbOption properties
Name
Type
Default value
Description
Text string? Text to display in the breadcrumb item.
Href string? URL to navigate to when this breadcrumb item is clicked. If provided, the breadcrumb will be rendered as a link.
Class string? CSS class attribute for breadcrumb item.
Style string? Style attribute for breadcrumb item.
IsSelected bool Display the item as the selected item.
IsEnabled bool true Whether an item is enabled or not.
BitVisibility enum
Name
Value
Description
Visible 0 The content of the component is visible.
Hidden 1 The content of the component is hidden, but the space it takes on the page remains (visibility:hidden).
Collapsed 2 The component is hidden (display:none).