Getting Started with .NET MAUI PullToRefresh

29 Jun 20265 minutes to read

This section guides you through setting up and configuring a PullToRefresh in your .NET MAUI application. Follow the steps below to add a basic PullToRefresh to your project.

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® MAUI PullToRefresh NuGet package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for Syncfusion.Maui.PullToRefresh 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

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 .NET MAUI project

  1. Open the command palette by pressing Ctrl+Shift+P and type .NET:New Project and 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® MAUI PullToRefresh 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.PullToRefresh to install the Syncfusion® .NET MAUI PullToRefresh 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 PullToRefresh NuGet package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for Syncfusion.Maui.PullToRefresh 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

Make sure to add the 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: Import PullToRefresh namespace

Add the following namespace in your XAML or C#.

xmlns:syncfusion="clr-namespace:Syncfusion.Maui.PullToRefresh;assembly=Syncfusion.Maui.PullToRefresh"
using Syncfusion.Maui.PullToRefresh;

Step 5: Add the PullToRefresh component

Configure the PullToRefresh component to enable you to refresh content interactively by performing a pull-down gesture. It enhances the user experience by providing a familiar and efficient way to update data. The PullableContent view serves as the designated area where users can initiate the pull-to-refresh action, enabling them to refresh and update the content within the view.

To show the progress indicator while updating the view, set IsRefreshing property to True using Refreshing event. Once view is updated, remove the progress indicator by setting IsRefreshing property to False.

<syncfusion:SfPullToRefresh x:Name="pullToRefresh">
    <syncfusion:SfPullToRefresh.PullableContent>
        <StackLayout>
            <Label Text="sample page" />
        </StackLayout>
    </syncfusion:SfPullToRefresh.PullableContent>
</syncfusion:SfPullToRefresh>
public MainPage()
{
    InitializeComponent();
    this.pullToRefresh.Refreshing += PullToRefresh_Refreshing;
}

private async void PullToRefresh_Refreshing(object? sender, EventArgs e)
{
    this.pullToRefresh.IsRefreshing = true;
    await Task.Delay(2000);
    this.pullToRefresh.IsRefreshing = false;
}

.NET MAUI PullToRefresh with slide on top transition mode

You can download the PullToRefresh Getting Started sample from GitHub.

If we run the above sample with TransitionMode set to Push, the output will be as shown in the following.

.NET MAUI PullToRefresh with slide on top transition mode.

NOTE

PullToRefresh does not have a view. So, it is mandatory to set size or LayoutOptions when loaded inside any layouts.