Getting started with .NET MAUI Step ProgressBar

30 Jul 20267 minutes to read

This section explains how to add the .NET MAUI Step ProgressBar control. This section covers only the basic features needed to get started with the Syncfusion® Step Progress Bar. Follow the steps below to add the .NET MAUI Step Progress Bar control to your project.

To get started quickly with the .NET MAUI Step Progress Bar, you can check the below video.

Prerequisites

Before proceeding, ensure the following are set up:

  1. Install .NET 9 SDK or later.
  2. Set up a .NET MAUI environment with Visual Studio 2022 v17.12 or later.

Step 1: Create a new .NET MAUI project

  1. Go to File > New > Project and choose the .NET MAUI App template.
  2. Name the project and choose a location. Then click Next.
  3. Select the .NET framework version and click Create.

Step 2: Install the Syncfusion® .NET MAUI ProgressBar NuGet package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for Syncfusion.Maui.ProgressBar and install the latest version.
  3. Ensure the necessary dependencies are installed correctly, and the project is restored.

Prerequisites

Before proceeding, ensure the following are set up:

  1. Install .NET 9 SDK or later.
  2. Set up a .NET MAUI environment with Visual Studio Code.
  3. Ensure that the .NET MAUI workloads are installed and configured as described here.

Step 1: Create a new .NET MAUI project

  1. Open the command palette by pressing Ctrl+Shift+P and type .NET: New Project and press Enter.
  2. Choose the .NET MAUI App template.
  3. Select the project location, type the project name and press Enter.
  4. Then choose Create project.

Step 2: Install the Syncfusion® .NET MAUI ProgressBar NuGet package

  1. Press Ctrl + ` (backtick) to open the integrated terminal in Visual Studio Code.
  2. Ensure you’re in the project root directory where your .csproj file is located.
  3. Run the command dotnet add package Syncfusion.Maui.ProgressBar to install the Syncfusion® .NET MAUI ProgressBar NuGet package.
  4. To ensure all dependencies are installed, run dotnet restore.

Prerequisites

Before proceeding, ensure the following are set up:

  1. Install .NET 9 SDK or later.
  2. Set up a .NET MAUI environment with JetBrains Rider 2024.3 or later.
  3. Make sure the MAUI workloads are installed and configured as described here.

Step 1: Create a new .NET MAUI project

  1. Go to File > New Solution, Select .NET (C#) and choose the .NET MAUI App template.
  2. Enter the Project Name, Solution Name, and Location.
  3. Select the .NET framework version and click Create.

Step 2: Install the Syncfusion® MAUI ProgressBar NuGet package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for Syncfusion.Maui.ProgressBar and install the latest version.
  3. Ensure the necessary dependencies are installed correctly, and the project is restored. If not, Open the Terminal in Rider and manually run: dotnet restore

Step 3: Register Syncfusion handler

Add the required namespace.

using Syncfusion.Maui.Core.Hosting;

Register the Syncfusion® core handler in your CreateMauiApp method of MauiProgram.cs file to use Syncfusion® controls.

builder.ConfigureSyncfusionCore();

Step 4: Create the ViewModel

You can use the ItemsSource property of SfStepProgressBar to populate the step progress bar items. Hence, you must create an item collection and bind it to the progress bar control.

Create a simple ObservableCollection of items for the step progress bar:

public class ViewModel
{
    private ObservableCollection<StepProgressBarItem> stepProgressItem;
    public ObservableCollection<StepProgressBarItem> StepProgressItem
    {
        get
        {
            return stepProgressItem;
        }
        set
        {
            stepProgressItem = value;
        }
    }

    public ViewModel()
    {
        stepProgressItem = new ObservableCollection<StepProgressBarItem>();
        stepProgressItem.Add(new StepProgressBarItem() { PrimaryText = "Cart" });
        stepProgressItem.Add(new StepProgressBarItem() { PrimaryText = "Address" });
        stepProgressItem.Add(new StepProgressBarItem() { PrimaryText = "Delivery" });
        stepProgressItem.Add(new StepProgressBarItem() { PrimaryText = "Ordered" });
    }
}

Step 5: Import Step ProgressBar namespace

Add the following namespace in your XAML or C# code.

xmlns:stepProgressBar="clr-namespace:Syncfusion.Maui.ProgressBar;assembly=Syncfusion.Maui.ProgressBar"
using Syncfusion.Maui.ProgressBar;

Step 6: Add the Step ProgressBar component

The Step ProgressBar control allows you to bind an item collection by setting the ItemsSource property of the SfStepProgressBar. Bind the item collection in both XAML and C#.

<stepProgressBar:SfStepProgressBar  x:Name="stepProgress"
                                    LabelSpacing="12"
                                    ActiveStepIndex="2"
                                    ActiveStepProgressValue="60"
                                    ProgressAnimationDuration="2500"
                                    ItemsSource="{Binding StepProgressItem}">
</stepProgressBar:SfStepProgressBar>

<ContentPage.BindingContext>
    <local:ViewModel />
</ContentPage.BindingContext>
ViewModel viewModel = new ViewModel();
SfStepProgressBar stepProgressBar = new SfStepProgressBar()
{
    LabelSpacing = 12,
    ActiveStepIndex = 2,
    ActiveStepProgressValue = 60,
    ProgressAnimationDuration = 2500,
    ItemsSource = viewModel.StepProgressItem,
};

this.Content = stepProgressBar;

Getting started of .NET MAUI StepProgressBar

You can download the Step Progress Bar Getting Started sample from GitHub.