Getting Started with .NET MAUI Carousel

This section guides you through setting up and configuring a Carousel in your .NET MAUI application. Follow the steps below to add a basic Carousel 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® .NET MAUI Toolkit NuGet package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for Syncfusion.Maui.Toolkit 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 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 Toolkit 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.Toolkit to install the Syncfusion® .NET MAUI Toolkit 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 Toolkit NuGet package

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

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

builder.ConfigureSyncfusionToolkit();

Add the following namespace in your XAML or C#.

xmlns:carousel="clr-namespace:Syncfusion.Maui.Toolkit.Carousel;assembly=Syncfusion.Maui.Toolkit"
using Syncfusion.Maui.Toolkit.Carousel;

Step 5: Define the Model and ViewModel

Carousel items can be added to the control using the ItemsSource property of SfCarousel. Objects of any class can be given as items for SfCarousel by using ItemsSource. The views corresponding to the objects can be set using the ItemTemplate for the content.

Create a model class using the image collection property that is initialized with the required number of data objects, as shown in the following code example.

  • C#
    • public class GalleryModel
{
    public GalleryModel(string imageString)
    {
        ImageName = imageString;
    }
    private string _imageName;

    public string ImageName
    {
        get { return _imageName; }
        set { _imageName = value; }
    }
}

public class GalleryViewModel
{
    public GalleryViewModel()
    {
        ImageCollection.Add(new GalleryModel("carousel_person1.png"));
        ImageCollection.Add(new GalleryModel("carousel_person2.png"));
        ImageCollection.Add(new GalleryModel("carousel_person3.png"));
        ImageCollection.Add(new GalleryModel("carousel_person4.png"));
        ImageCollection.Add(new GalleryModel("carousel_person5.png"));
    }
    private List<GalleryModel> imageCollection = new List<GalleryModel>();
    public List<GalleryModel> ImageCollection
    {
        get { return imageCollection; }
        set { imageCollection = value; }
    }
}

    NOTE

    The images used in the above view model should be added in the Resources folder of the Application.

    The following code example illustrates how to add the collection in Carousel,

    <ContentPage.Resources>
    <ResourceDictionary>
        <DataTemplate x:Key="itemTemplate">
            <Image Source="{Binding Image}" 
                    Aspect="AspectFit"/>
        </DataTemplate>
    </ResourceDictionary>
<ContentPage.Resources>

    <carousel:SfCarousel x:Name="carousel"
                         ItemTemplate="{StaticResource itemTemplate}" 
                         ItemsSource="{Binding ImageCollection}"
                         ItemHeight="170"
                         ItemWidth="270"
                         SelectedIndex="4">
        <carousel:SfCarousel.BindingContext>
            <local:CarouselViewModel/>
        </carousel:SfCarousel.BindingContext>
    </carousel:SfCarousel>
    CarouselViewModel carouselViewModel = new CarouselViewModel();

    SfCarousel carousel = new SfCarousel()
    {
        ItemHeight = 170,
        ItemWidth = 270,
        SelectedIndex = 4
    };

    var itemTemplate = new DataTemplate(() =>
    {
        var grid = new Grid();
        var nameLabel = new Image();
        nameLabel.SetBinding(Image.SourceProperty, "Image");
        grid.Children.Add(nameLabel);
        return grid;
    });

    carousel.BindingContext = carouselViewModel;
    carousel.ItemTemplate = itemTemplate;
    carousel.SetBinding(SfCarousel.ItemsSourceProperty, "ImageCollection");

    this.Content = carousel;

    OverView image for Carousel

    You can download the Carousel View Getting Started sample from here.