Syncfusion.Maui.Carousel

Syncfusion .NET MAUI Carousel (SfCarousel)

The Syncfusion .NET MAUI Carousel control allows users to navigate through image data in an interactive way so that it can be viewed or selected. It provides a rich, gallery-like browsing experience with various customization options for item arrangements, and it works across Android, iOS, macOS, and Windows from a single codebase.

Documentation · Getting Started · API Reference · Demos on GitHub · Product Page · Release Notes

---

Key features

Data binding and item layout

• Bind to any IEnumerable<object> collection, including ObservableCollection<T>.
• Populate items from images using SfCarouselItem, or render any custom view per item with the ItemTemplate property.
• Two item arrangements: Linear and Default, through the ViewMode property.

Customization

• Item size: control item dimensions with ItemWidth and ItemHeight.
• Spacing: set the gap between items using ItemSpacing.
• Rotation: adjust the rotation of items in linear mode using RotationAngle.
• Scaling: display the selected and unselected items in different sizes using ScaleOffset.
• Positioning: place the selected item anywhere in the viewport using SelectedItemOffset.
• Animation speed: control how long a transition takes using Duration.

Interaction

• Swipe to navigate through items, moving either one item or multiple items at a time, using the SwipeMovementMode property.
• Enable or disable user interaction with EnableInteraction.
• Track or set the current item using SelectedIndex.

Performance

• Load more items on demand using the AllowLoadMore, LoadMoreItemsCount, and LoadMoreView properties.

---

Supported platforms

Platform	Target framework
Android	net9.0-android, net10.0-android
iOS	net9.0-ios, net10.0-ios
macOS (Mac Catalyst)	net9.0-maccatalyst, net10.0-maccatalyst
Windows	net9.0-windows10.0.19041, net10.0-windows10.0.19041

Minimum OS versions follow the .NET MAUI supported platforms.

---

Installation

.NET CLI

dotnet add package Syncfusion.Maui.Carousel

Package Manager Console

Install-Package Syncfusion.Maui.Carousel

---

Getting started

1. Register the Syncfusion core handler

In MauiProgram.cs, call ConfigureSyncfusionCore():

using Syncfusion.Maui.Core.Hosting;

public static class MauiProgram
{
    public static MauiApp CreateMauiApp()
    {
        var builder = MauiApp.CreateBuilder();
        builder
            .UseMauiApp<App>()
            .ConfigureSyncfusionCore();

        return builder.Build();
    }
}

2. Create a model and a ViewModel

using System.Collections.ObjectModel;
using Syncfusion.Maui.Carousel;

public class CarouselModel
{
    public string ImageName { get; set; }
}

public class CarouselViewModel
{
    public ObservableCollection<CarouselModel> CarouselItems { get; set; }

    public CarouselViewModel()
    {
        CarouselItems = new ObservableCollection<CarouselModel>
        {
            new CarouselModel { ImageName = "image1.png" },
            new CarouselModel { ImageName = "image2.png" },
            new CarouselModel { ImageName = "image3.png" }
        };
    }
}

3. Add SfCarousel to your page

<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:syncfusion="clr-namespace:Syncfusion.Maui.Carousel;assembly=Syncfusion.Maui.Carousel"
             xmlns:local="clr-namespace:YourAppNamespace"
             x:Class="YourAppNamespace.MainPage">

    <ContentPage.BindingContext>
        <local:CarouselViewModel />
    </ContentPage.BindingContext>

    <syncfusion:SfCarousel ItemsSource="{Binding CarouselItems}"
                           ItemWidth="200"
                           ItemHeight="200">
        <syncfusion:SfCarousel.ItemTemplate>
            <DataTemplate>
                <Image Source="{Binding ImageName}" Aspect="AspectFit" />
            </DataTemplate>
        </syncfusion:SfCarousel.ItemTemplate>
    </syncfusion:SfCarousel>

</ContentPage>

Run the app and swipe to navigate through the carousel items.

---

Common scenarios

Customize the item arrangement

<syncfusion:SfCarousel ItemsSource="{Binding CarouselItems}"
                       ViewMode="Default"
                       RotationAngle="45"
                       Offset="60"
                       ScaleOffset="0.8"
                       SelectedItemOffset="0"
                       ItemSpacing="12" />

Show a load-more view

<syncfusion:SfCarousel ItemsSource="{Binding CarouselItems}"
                       AllowLoadMore="True"
                       LoadMoreItemsCount="3">
    <syncfusion:SfCarousel.LoadMoreView>
        <Button Text="Load more" />
    </syncfusion:SfCarousel.LoadMoreView>
</syncfusion:SfCarousel>

For more features, see the Carousel documentation.

---

Dependencies

Installing this package also installs the following packages:

• Microsoft.Maui.Controls
• Syncfusion.Maui.Core

---

Licensing

This is a commercial product and requires a paid license. You have three options:

• Free Community License: for individual developers and small businesses. Check eligibility
• 30-day free trial: Start a trial
• Commercial license: View pricing

Register your license key

Register the key in MauiProgram.cs before the app is built:

Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR_LICENSE_KEY");

For details, see Licensing overview. Use of this package is subject to the Syncfusion EULA.

---

Support and feedback

• Support tickets: Syncfusion Support Portal
• Community forums: .NET MAUI Forums
• Feature requests and bug reports: Feedback Portal
• Samples: Syncfusion .NET MAUI demos on GitHub

---

About Syncfusion®

Founded in 2001 and headquartered in Research Triangle Park, N.C., Syncfusion® has more than 26,000+ customers and more than 1 million users, including large financial institutions, Fortune 500 companies, and global IT consultancies.

Today, we provide 1600+ components and frameworks for web (Blazor, ASP.NET Core, ASP.NET MVC, ASP.NET WebForms, JavaScript, Angular, React, Vue, and Flutter), mobile (.NET MAUI, Xamarin, Flutter, UWP, and JavaScript), and desktop development (WinForms, WPF, WinUI, Flutter and UWP). We provide ready-to-deploy enterprise software for dashboards, reports, data integration, and big data processing. Many customers have saved millions in licensing fees by deploying our software.

---

[email protected] | www.syncfusion.com | Toll Free: 1-888-9 DOTNET