Class MudStep

Namespace

MudBlazor

Assembly

MudBlazor.dll

A individual step as part of a MudStepper.

public class MudStep : MudComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged, IAsyncDisposable

Inheritance

object

ComponentBase

ComponentBaseWithState

MudComponentBase

MudStep

Implements

IComponent

IHandleEvent

IHandleAfterRender

IMudStateHasChanged

IAsyncDisposable

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.BuildRenderTree(RenderTreeBuilder)

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

MudStep()

public MudStep()

Properties

ChildContent

The content for this step.

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

Property Value

RenderFragment

Remarks

Defaults to null. Only shown when this step is active.

Completed

Whether this step is completed.

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

Property Value

bool

Remarks

Defaults to false.

CompletedChanged

Occurs when Completed has changed.

[Parameter]
[Category("Behavior")]
public EventCallback<bool> CompletedChanged { get; set; }

Property Value

EventCallback<bool>

CompletedStepColor

The color used when this step is completed.

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

Property Value

Color?

Remarks

Defaults to null.

Disabled

Prevents this step from being selected.

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

Property Value

bool

DisabledChanged

Occurs when Disabled has changed.

[Parameter]
[Category("Behavior")]
public EventCallback<bool> DisabledChanged { get; set; }

Property Value

EventCallback<bool>

ErrorStepColor

The color used when this step has an error.

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

Property Value

Color?

Remarks

Defaults to null.

HasError

Whether this step has an error.

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

Property Value

bool

Remarks

Defaults to false.

HasErrorChanged

Occurs when HasError has changed.

[Parameter]
[Category("Behavior")]
public EventCallback<bool> HasErrorChanged { get; set; }

Property Value

EventCallback<bool>

IsActive

Whether this step is the current one being displayed.

public bool IsActive { get; }

Property Value

bool

OnClick

Occurs when this step is clicked.

[Parameter]
[Category("Behavior")]
public EventCallback<MouseEventArgs> OnClick { get; set; }

Property Value

EventCallback<MouseEventArgs>

SecondaryText

The subtitle describing this step.

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

Property Value

string

Remarks

Defaults to null.

Skippable

Whether the user can skip this step.

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

Property Value

bool

Remarks

Defaults to false.

Title

The title of this step.

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

Property Value

string

Remarks

Defaults to null.

Methods

DisposeAsync()

Releases resources used by this component.

public ValueTask DisposeAsync()

Returns

ValueTask

OnInitializedAsync()

protected override Task OnInitializedAsync()

Returns

Task

SetCompletedAsync(bool, bool)

Sets the Completed parameter, and optionally refreshes the parent MudStepper.

public Task SetCompletedAsync(bool value, bool refreshParent = true)

Parameters

value bool

refreshParent bool

Returns

Task

SetDisabledAsync(bool, bool)

Sets the Disabled parameter, and optionally refreshes the parent MudStepper.

public Task SetDisabledAsync(bool value, bool refreshParent = true)

Parameters

value bool

refreshParent bool

Returns

Task

SetHasErrorAsync(bool, bool)

Sets the HasError parameter, and optionally refreshes the parent MudStepper.

public Task SetHasErrorAsync(bool value, bool refreshParent = true)

Parameters

value bool

refreshParent bool

Returns

Task