Class StepperStep

A class that represents steps of SfStepper component.

Inheritance

System.Object

StepperStep

Namespace: Syncfusion.Blazor.Navigations

Assembly: Syncfusion.Blazor.dll

Syntax

public class StepperStep : OwningComponentBase

Constructors

StepperStep()

Declaration

public StepperStep()

Properties

CssClass

Gets or sets the custom CSS class for customize the appearance of step.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	A string representing the CSS class to be applied to the step. The default value is an empty string.

Remarks

You can use this property to apply custom styles to individual steps within the Stepper component by specifying a CSS class.

Disabled

Gets or sets a value indicating whether the step is disabled.

Declaration

public bool Disabled { get; set; }

Property Value

Type	Description
System.Boolean	true if the step is disabled; otherwise, false. The default value is false.

Remarks

Disabled steps are not interactive and cannot be progressed to.

IconCss

Gets or sets the CSS class for the icon associated with the StepperStep.

Declaration

public string IconCss { get; set; }

Property Value

Type	Description
System.String	A string representing the CSS class for the icon. The default value is an empty string.

Remarks

The icon CSS class is used to style the icon displayed for the step. If specified, it determines the visual representation of the step.

IsValid

Gets or sets a value indicating whether the step is valid.

Declaration

public Nullable<bool> IsValid { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	true if the step is valid completion; otherwise, false. The default value is false.

Remarks

Indicate whether a step's required criteria have been met.

Label

Gets or sets the label for the StepperStep.

Declaration

public string Label { get; set; }

Property Value

Type	Description
System.String	A string representing the label of the step. The default value is an empty string.

Remarks

The label can provide additional information or context for the step. If both the Label and Text properties are defined, this property will be prioritized for display.

Optional

Gets or sets a value indicating whether the step is optional.

Declaration

public bool Optional { get; set; }

Property Value

Type	Description
System.Boolean	true if the step is optional; otherwise, false. The default value is false.

Remarks

If a step is optional, users may choose to skip it without affecting the overall process.

Status

Gets or sets the status of the step.

Declaration

public StepperStatus Status { get; set; }

Property Value

Type	Description
StepperStatus	A StepperStatus value representing the status of the step. The default value is NotStarted.

Remarks

The status indicates the progress or state of the step, which can be one of the following:

• NotStarted
• InProgress
• Completed

Text

Gets or sets the text content for the StepperStep.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	A string representing the text content of the step. The default value is an empty string.

Remarks

The text content provides descriptive information for the step.

Methods

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnAfterRender(Boolean)

Declaration

protected override void OnAfterRender(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type
System.Threading.Tasks.Task