Class TwStep

Namespace

TwBlazor.Components

Assembly

TwBlazor.dll

Represents a single step within a TwStepper.

public class TwStep : TwBlazorComponentBase, IComponent, IHandleEvent, IHandleAfterRender, ITwComponent

Inheritance

object

ComponentBase

TwBlazorComponentBase

TwStep

Implements

IComponent

IHandleEvent

IHandleAfterRender

ITwComponent

Inherited Members

TwBlazorComponentBase.OnParametersSet()

TwBlazorComponentBase.options

TwBlazorComponentBase.roundedBuilder

TwBlazorComponentBase.shadowBuilder

TwBlazorComponentBase.colorBuilder

TwBlazorComponentBase.iconColorBuilder

TwBlazorComponentBase.popoverBuilder

TwBlazorComponentBase.Id

TwBlazorComponentBase.Class

TwBlazorComponentBase.Style

TwBlazorComponentBase.Attributes

TwBlazorComponentBase.AriaLabel

TwBlazorComponentBase.AriaLabelledBy

TwBlazorComponentBase.Shadow

TwBlazorComponentBase.Rounded

TwBlazorComponentBase.effectiveShadow

TwBlazorComponentBase.effectiveRounded

TwBlazorComponentBase.hasUserProvidedId

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.SetParametersAsync(ParameterView)

ComponentBase.RendererInfo

ComponentBase.Assets

ComponentBase.AssignedRenderMode

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

A TwStep declares no markup of its own - TwStepper renders every step's indicator, label, and description itself (the same registration pattern TwTab uses with TwTabContainer), so declaring a TwStep just adds an entry to its parent's step list, in the order it appears in markup.

Constructors

TwStep()

public TwStep()

Properties

ChildContent

Gets or sets optional content for this step. On Horizontal, it is rendered in a shared panel below the step row while this step is active; on Vertical, it is rendered inline beneath this step's label while this step is active.

[Parameter]
public RenderFragment? ChildContent { get; set; }

Property Value

RenderFragment

Description

Gets or sets a short secondary description shown beneath the label (e.g. "Optional").

[Parameter]
public string? Description { get; set; }

Property Value

string

Disabled

Gets or sets whether this step is disabled and cannot be navigated to.

[Parameter]
public bool Disabled { get; set; }

Property Value

bool

Icon

Gets or sets an icon to display in the step's indicator instead of its step number, while the step is active or upcoming. A completed step always shows a checkmark regardless of this value.

[Parameter]
public Icon? Icon { get; set; }

Property Value

Icon?

Label

Gets or sets the label displayed for this step.

[Parameter]
public required string Label { get; set; }

Property Value

string

Parent

The parent stepper this step belongs to. Set via cascading parameter.

[CascadingParameter]
public required TwStepper Parent { get; set; }

Property Value

TwStepper

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

OnInitialized()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree.

protected override void OnInitialized()