Blazorise Step component

The Step component displays progress through numbered steps.

Similar to Tabs component, the step component have the same structure and usage.

<Steps> container for Step items.
- <Items> collection of step items.
  - <Step> individual step item, which can be clicked to navigate to the step content.
- <Content> container for step content.
  - <StepPanel> individual step content, which is displayed when the step item is clicked.

The Steps component is container for Step items. The Name of each step item should match the Name of a step panel(if panels are used).

<StepsContent> container for step panels
- <StepPanel> container for step content

The step content container is used to hold step panels. Each content pane also has a unique Name, which is targeted by a link in the step-strip.

Most of the time you will only need to use Steps component as it is crafted to hold both clickable step items and step content. Only in the advanced scenario where the content will be separated from the step items you will need to use StepsContent component.

Examples

Basic

1 Create campaign settings
2 Create an ad group
3 Create an add
Finish

Content for step 1.

Content for step 2.

Content for step 3.

Content for finish.

<Steps SelectedStep="@selectedStep" SelectedStepChanged="@OnSelectedStepChanged">
    <Items>
        <Step Name="step1">Create campaign settings</Step>
        <Step Name="step2">Create an ad group</Step>
        <Step Name="step3">Create an add</Step>
        <Step Name="step4">
            <Marker>
                <Icon Name="IconName.Flag" />
            </Marker>
            <Caption>
                Finish
            </Caption>
        </Step>
    </Items>
    <Content>
        <StepPanel Name="step1">
            Content for step 1.
        </StepPanel>
        <StepPanel Name="step2">
            Content for step 2.
        </StepPanel>
        <StepPanel Name="step3">
            Content for step 3.
        </StepPanel>
        <StepPanel Name="step4">
            Content for finish.
        </StepPanel>
    </Content>
</Steps>

@code{
    string selectedStep = "step1";

    private Task OnSelectedStepChanged( string name )
    {
        selectedStep = name;

        return Task.CompletedTask;
    }
}

Navigation Control

Basic steps navigation has no constraints, so it is possible to jump to any steps by clicking on them. However, this is usually impossible in real-world scenarios as sometimes a user is required to enter valid data before proceeding to the next step.

To control the navigation between the steps, you need to use the NavigationAllowed parameter, which acts as a function that has all the information you need to validate the page switch.

1 Step 1
2 Step 2
3 Step 3
4 Step 4

Step 1

Email address This field is required in order to proceed to the next step.

Step 3

Step 4

<Steps @ref="stepsRef" @bind-SelectedStep="@selectedStep" NavigationAllowed="NavigationAllowed">
    <Items>
        <Step Name="1">Step 1</Step>
        <Step Name="2">Step 2</Step>
        <Step Name="3">Step 3</Step>
        <Step Name="4">Step 4</Step>
    </Items>
    <Content>
        <StepPanel Name="1">
            Step 1
        </StepPanel>
        <StepPanel Name="2">
            <Field>
                <FieldLabel>Email address</FieldLabel>
                <TextInput @bind-Value="email" Placeholder="Enter email">
                    <FieldHelp>This field is required in order to proceed to the next step.</FieldHelp>
                </TextInput>
            </Field>
        </StepPanel>
        <StepPanel Name="3">
            Step 3
        </StepPanel>
        <StepPanel Name="4">
            Step 4
        </StepPanel>
    </Content>
</Steps>
<Div Flex="Flex.JustifyContent.Center">
    <Button Color="Color.Secondary" Margin="Margin.Is2.FromEnd" Clicked="() => stepsRef.PreviousStep()">
        Previous
    </Button>
    <Button Color="Color.Primary" Clicked="() => stepsRef.NextStep()">
        Next
    </Button>
</Div>

@code {
    private Steps stepsRef;
    private string email;
    private string selectedStep = "2";

    private Task<bool> NavigationAllowed( StepNavigationContext context )
    {
        if ( context.CurrentStepIndex == 2 && context.NextStepIndex > 2 && !ValidationRule.IsEmail( email ) )
        {
            return Task.FromResult( false );
        }

        return Task.FromResult( true );
    }
}

Lazy Load

You are able to set the Steps component to lazy load your steps.

1 Step 1
2 Step 2

This Steps component is set to LazyLoad mode, meaning each step will only be rendered/loaded the first time it is visited. This is specially useful when you want to delay some heavy or long waited operations for when the step is actually clicked instead.

<Steps RenderMode="StepsRenderMode.LazyLoad" SelectedStep="step1">
    <Items>
        <Step Name="step1">Step 1</Step>
        <Step Name="step2">Step 2</Step>
    </Items>
    <Content>
        <StepPanel Name="step1">
            This Steps component is set to <code>LazyLoad</code> mode, meaning each step will only be rendered/loaded the first time it is visited.
            This is specially useful when you want to delay some heavy or long waited operations for when the step is actually clicked instead.
            <TextInput></TextInput>
        </StepPanel>
        <StepPanel Name="step2">
            <TextInput></TextInput>
        </StepPanel>
    </Content>
</Steps>

Lazy Reload

You are able to set the Steps component to lazy load your steps everytime.

1 Step 1
2 Step 2

This Steps component is set to LazyReload mode, meaning that only the active tab will have it's html rendered at a time. Try typing some text in the provided Text components and changing between tabs, the tab will always be refreshed as the tab content is always lazy loaded, therefore re-calculated.

<Steps RenderMode="StepsRenderMode.LazyReload" SelectedStep="step1">
    <Items>
        <Step Name="step1">Step 1</Step>
        <Step Name="step2">Step 2</Step>
    </Items>
    <Content>
        <StepPanel Name="step1">
            This Steps component is set to <code>LazyReload</code> mode, meaning that only the active tab will have it's html rendered at a time. 
            Try typing some text in the provided Text components and changing between tabs, the tab will always be refreshed as the tab content is always lazy loaded, 
            therefore re-calculated.
            <TextInput></TextInput>
        </StepPanel>
        <StepPanel Name="step2">
            <TextInput></TextInput>
        </StepPanel>
    </Content>
</Steps>

Best Practices

True Sequence

Steps suit a multi-stage task with a clear beginning and end, not general-purpose page navigation. Give each stage a short label that describes its goal and show the user's current position. Keep the sequence manageable by combining steps that are too small to stand on their own.

Protect Progress

Validate the current step before allowing forward navigation, but let users return to completed steps without losing their input. If leaving the workflow would discard meaningful work, explain that consequence before navigating away.

API

See the API reference for the parameters, events, methods, and related types available to the components covered on this page.