Blazorise Step API
Explore the Blazorise Step API reference for parameters, events, methods, and related types.
For examples and usage guidance, see the Step documentation.
API
Parameters
Steps
| Parameter | Description | Type | Default |
|---|---|---|---|
ChildContent |
Specifies the content to be rendered inside this Steps. |
RenderFragment | null |
Content |
Template for placing the StepPanel items. |
RenderFragment | null |
Items |
Template for placing the Step items. |
RenderFragment | null |
RenderMode |
Specifies how the steps content will be rendered. Possible values: |
StepsRenderMode | StepsRenderMode.Default |
SelectedStep |
Specifies the currently selected step name. |
string |
Step
| Parameter | Description | Type | Default |
|---|---|---|---|
Caption |
Custom render template for the text part of the step item. |
RenderFragment | null |
ChildContent |
Specifies the content to be rendered inside this Step. |
RenderFragment | null |
Color |
Overrides the step color. |
Color | Color.Default |
Completed |
Marks the step as completed. |
bool | false |
Index |
Overrides the index of the step item. |
int? | null |
Intent |
Overrides the step intent. |
Intent | null |
Marker |
Custom render template for the marker(circle) part of the step item. |
RenderFragment | null |
Name |
Specifies the step name. |
string |
StepsContent
| Parameter | Description | Type | Default |
|---|---|---|---|
ChildContent |
Specifies the content to be rendered inside this StepsContent. |
RenderFragment | null |
SelectedPanel |
Specifies the currently selected panel name. |
string |
StepPanel
| Parameter | Description | Type | Default |
|---|---|---|---|
ChildContent |
Specifies the content to be rendered inside this StepPanel. |
RenderFragment | null |
Name |
Specifies the panel name. Must match the corresponding step name. |
string |
Events
Steps
| Event | Description | Type |
|---|---|---|
NavigationAllowed |
Disables navigation by clicking on step. |
Func<StepNavigationContext, Task<bool>> |
SelectedStepChanged |
Occurs after the selected step has changed. |
EventCallback<string> |
Step
| Event | Description | Type |
|---|---|---|
Clicked |
Notifies when the item is clicked. |
EventCallback<MouseEventArgs> |
StepsContent
| Event | Description | Type |
|---|---|---|
SelectedPanelChanged |
Occurs after the selected panel has changed. |
EventCallback<string> |
Methods
Steps
| Method | Description | Return | Parameters |
|---|---|---|---|
NextStep |
Goes to the next step. | Task<bool> | |
PreviousStep |
Goes to the previous step. | Task<bool> | |
SelectStep |
Sets the active step by the name. | Task<bool> | string stepName |
StepsContent
| Method | Description | Return | Parameters |
|---|---|---|---|
SelectPanel |
Select the panel by name. | Task | string name |