Class MudBreadcrumbs

Namespace

MudBlazor

Assembly

MudBlazor.dll

Represents a series of links used to show the user's current location.

public class MudBreadcrumbs : MudComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged

Inheritance

object

ComponentBase

ComponentBaseWithState

MudComponentBase

MudBreadcrumbs

Implements

IComponent

IHandleEvent

IHandleAfterRender

IMudStateHasChanged

Inherited Members

MudComponentBase.OnAfterRender(bool)

MudComponentBase.Logger

MudComponentBase.Class

MudComponentBase.Style

MudComponentBase.Tag

MudComponentBase.UserAttributes

MudComponentBase.IsJSRuntimeAvailable

MudComponentBase.FieldId

ComponentBaseWithState.OnInitialized()

ComponentBaseWithState.SetParametersAsync(ParameterView)

ComponentBaseWithState.OnParametersSet()

ComponentBaseWithState.CreateRegisterScope()

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

EventUtil.AsNonRenderingEventHandler(ComponentBase, Action)

EventUtil.AsNonRenderingEventHandler(ComponentBase, Func<Task>)

EventUtil.AsNonRenderingEventHandler<TValue>(ComponentBase, Action<TValue>)

EventUtil.AsNonRenderingEventHandler<TValue>(ComponentBase, Func<TValue, Task>)

ComponentBaseWithStateExtensions.GetState<T>(ComponentBaseWithState, string)

ComponentBaseWithStateExtensions.GetState<TComponent, T>(TComponent, Func<TComponent, T>, string?)

ObjectExtensions.As<T>(object?)

Constructors

MudBreadcrumbs()

public MudBreadcrumbs()

Properties

Collapsed

Collapses items when the number of items exceeds MaxItems.

public bool Collapsed { get; }

Property Value

bool

Remarks

Defaults to true.

ExpanderIcon

The icon to display when items are collapsed.

[Parameter]
[Category("Appearance")]
public string ExpanderIcon { get; set; }

Property Value

string

Remarks

Defaults to SettingsEthernet. Displays when Collapsed and the number of items exceeds MaxItems.

ItemTemplate

The custom template used to display items.

[Parameter]
[Category("Behavior")]
public RenderFragment<BreadcrumbItem>? ItemTemplate { get; set; }

Property Value

RenderFragment<BreadcrumbItem>

Items

The list of items to display.

[Parameter]
[Category("Behavior")]
public IReadOnlyList<BreadcrumbItem>? Items { get; set; }

Property Value

IReadOnlyList<BreadcrumbItem>

MaxItems

The maximum number of items to display.

[Parameter]
[Category("Behavior")]
public byte? MaxItems { get; set; }

Property Value

byte?

Remarks

Defaults to null. If Collapsed is true and the number of items exceeds this value, the breadcrumbs will automatically collapse.

Separator

The separator shown between items.

[Parameter]
[Category("Appearance")]
public string Separator { get; set; }

Property Value

string

Remarks

Defaults to /. Will not be shown if SeparatorTemplate is set.

SeparatorTemplate

The content shown between items.

[Parameter]
[Category("Appearance")]
public RenderFragment? SeparatorTemplate { get; set; }

Property Value

RenderFragment

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

See Also

BreadcrumbItem

BreadcrumbLink

BreadcrumbSeparator