Class MudNavLink

Namespace

MudBlazor

Assembly

MudBlazor.dll

A navigation link as part of a MudNavMenu.

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

Inheritance

object

ComponentBase

ComponentBaseWithState

MudComponentBase

MudNavLink

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

MudNavLink()

public MudNavLink()

Properties

ActiveClass

The CSS applied when this link is active.

[Parameter]
[Category("Common")]
public string ActiveClass { get; set; }

Property Value

string

Remarks

Defaults to active. Multiple classes must be separated by spaces.

Attributes

protected Dictionary<string, object?> Attributes { get; }

Property Value

Dictionary<string, object>

ChildContent

The content within this link.

[Parameter]
[Category("Behavior")]
public RenderFragment? ChildContent { get; set; }

Property Value

RenderFragment

Classname

protected string Classname { get; }

Property Value

string

Disabled

Prevents the user from interacting with this link.

[Parameter]
[Category("Behavior")]
public bool Disabled { get; set; }

Property Value

bool

ForceLoad

Performs a full page load during navigation.

[Parameter]
[Category("Click action")]
public bool ForceLoad { get; set; }

Property Value

bool

Remarks

Defaults to false. When true, client-side routing is bypassed and the browser is forced to load the new page from the server.

Href

The URL to navigate to when this link is clicked.

[Parameter]
[Category("Click action")]
public string? Href { get; set; }

Property Value

string

Icon

The icon displayed for this link.

[Parameter]
[Category("Behavior")]
public string? Icon { get; set; }

Property Value

string

Remarks

Defaults to null.

IconClassname

protected string IconClassname { get; }

Property Value

string

IconColor

The color of the icon when Icon is set.

[Parameter]
[Category("Appearance")]
public Color IconColor { get; set; }

Property Value

Color

Remarks

Defaults to Default.

LinkClassname

protected string LinkClassname { get; }

Property Value

string

Match

Controls when this link is highlighted.

[Parameter]
[Category("Behavior")]
public NavLinkMatch Match { get; set; }

Property Value

NavLinkMatch

Remarks

Defaults to Prefix. This link is compared against the current URL to determine whether it is highlighted.

OnClick

Occurs when this link has been clicked.

[Parameter]
public EventCallback<MouseEventArgs> OnClick { get; set; }

Property Value

EventCallback<MouseEventArgs>

Remarks

This event only occurs when the Href property has not been set.

Ripple

Shows a ripple effect when the user clicks this link.

[Parameter]
[Category("Appearance")]
public bool Ripple { get; set; }

Property Value

bool

Remarks

Defaults to true.

TabIndex

protected int TabIndex { get; }

Property Value

int

Target

The browser frame to open this link when Href is specified.

[Parameter]
[Category("Click action")]
public string? Target { get; set; }

Property Value

string

Remarks

Possible values include _blank, _self, _parent, _top, or a frame name.
Defaults to null.

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

HandleNavigation()

protected Task HandleNavigation()

Returns

Task

OnClickHandler(MouseEventArgs)

protected Task OnClickHandler(MouseEventArgs ev)

Parameters

ev MouseEventArgs

Returns

Task

See Also

MudNavGroup

MudNavMenu