New to Telerik UI for Blazor? Start a free 30-day trial

StepperStep

Class

Defines a single step within a TelerikStepper. Configure label and visuals via Label, Text, Icon, and custom Template; control behavior with Optional, Disabled, and validation indicator through Valid. Use OnChange to intercept navigation before the step changes, and set accessibility with AriaControls.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

public class StepperStep : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseStepperStep

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members ComponentBase.OnInitializedAsync()ComponentBase.OnParametersSet()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)...

Constructors

StepperStep()

public StepperStep()

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

public void Dispose()

Implements: IDisposable.Dispose()

OnInitialized()

protected override void OnInitialized()

Overrides: ComponentBase.OnInitialized()

Properties

AriaControls

string

[Accessibility] Specifies the aria-controls attribute of the step.

[Parameter]
public string AriaControls { get; set; }

Class

string

Defines the CSS class of the step.

[Parameter]
public string Class { get; set; }

Disabled

bool

Specifies if the step is disabled. If a step is disabled, users cannot select it.

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

Icon

object

Specifies the icon rendered in the step. You can use either a predefined Telerik Icon or a custom one. Refer to Icons - Documentation for more information on how icons work.

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

Label

string

Defines the label of the step.

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

OnChange

EventCallback<StepperStepChangeEventArgs>

Triggers before the step change.

[Parameter]
public EventCallback<StepperStepChangeEventArgs> OnChange { get; set; }

Optional

bool

Specifies if the step is optional. If "true", the step will show the label "(Optional)" to indicate that the step is not mandatory.

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

Template

RenderFragment

Defines the template of the step. See https://docs.telerik.com/blazor-ui/components/stepper/step-template.

[Parameter]
public RenderFragment Template { get; set; }

Text

string

Defines the text of the step. If Text and Icon are not set, the Component will show the step number.

[Parameter]
public string Text { get; set; }

Valid

bool?

Specifies if the step is valid. Step validation serves as a visual indication whether a step is valid or not. It does not prevent users from navigating between steps. Default value is "null".

[Parameter]
public bool? Valid { get; set; }