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 | Default | Type |
|---|---|---|
AriaLabel | — | string |
Specifies the accessible name of the step list when no visible label is available. | ||
AriaLabelledBy | — | string |
Specifies the space-separated IDs of elements that label the step list. | ||
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this Steps. | ||
Content | null | RenderFragment |
Template for placing the StepPanel items. | ||
Items | null | RenderFragment |
Template for placing the Step items. | ||
RenderMode | StepsRenderMode.Default | StepsRenderMode |
Specifies how the steps content will be rendered. Possible values: DefaultLazyLoadLazyReload | ||
SelectedStep | — | string |
Specifies the currently selected step name. | ||
StepAlignment | StepAlignment.Default | StepAlignment |
Specifies how horizontal steps are distributed across the available width. Defaults to Default, preserving the provider's layout. Possible values: DefaultStartCenterEndSpaceBetweenJustified | ||
StepPosition | Top | StepPosition |
Specifies the placement of the steps relative to their content. Defaults to Top. Possible values: TopBottomStartEnd | ||
Step
| Parameter | Default | Type |
|---|---|---|
AriaLabelledBy | — | string |
Specifies the space-separated IDs of elements that label this step. | ||
Caption | null | RenderFragment |
Custom render template for the text part of the step item. | ||
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this Step. | ||
Color | Color.Default | Color |
Overrides the step color. | ||
Completed | false | bool |
Marks the step as completed. | ||
Index | null | int? |
Overrides the index of the step item. | ||
Intent | null | Intent |
Overrides the step intent. | ||
Marker | null | RenderFragment |
Custom render template for the marker(circle) part of the step item. | ||
Name | — | string |
Specifies the step name. | ||
StepsContent
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this StepsContent. | ||
SelectedPanel | — | string |
Specifies the currently selected panel name. | ||
StepPanel
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this StepPanel. | ||
Focusable | true | bool |
Gets or sets whether the active panel is included in the keyboard Tab sequence. Defaults to true. Setting this to false does not affect focusable elements inside the panel. | ||
Name | — | string |
Specifies the panel name. Must match the corresponding step name. | ||
Events
Steps
| Event | Type |
|---|---|
NavigationAllowed | Func<StepNavigationContext, Task<bool>> |
Disables navigation by clicking on step. | |
SelectedStepChanged | EventCallback<string> |
Occurs after the selected step has changed. | |
Step
| Event | Type |
|---|---|
Clicked | EventCallback<MouseEventArgs> |
Notifies when the item is clicked. | |
StepsContent
| Event | Type |
|---|---|
SelectedPanelChanged | EventCallback<string> |
Occurs after the selected panel has changed. | |
Methods
Steps
| Method | Return | Parameters |
|---|---|---|
NextStep | Task<bool> | — |
Goes to the next step.
| ||
PreviousStep | Task<bool> | — |
Goes to the previous step.
| ||
SelectStep | Task<bool> | string stepName |
Sets the active step by the name.
| ||
StepsContent
| Method | Return | Parameters |
|---|---|---|
SelectPanel | Task | string name |
Select the panel by name.
| ||