Getting Started with .NET MAUI ListView

31 Jul 202611 minutes to read

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

To quickly get started with the .NET MAUI ListView, watch this 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® MAUI ListView NuGet package

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

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

Data Model

Create a simple data model as shown in the following code example, and save it as BookInfo.cs file.

public class BookInfo : INotifyPropertyChanged
{
    private string bookName;
    private string bookDesc;

    public BookInfo(string bookName, string bookDesc)
    {
        this.bookName = bookName;
        this.bookDesc = bookDesc;
    }

    public string BookName
    {
        get { return bookName; }
        set
        {
            bookName = value;
            OnPropertyChanged("BookName");
        }
    }

    public string BookDescription
    {
        get { return bookDesc; }
        set
        {
            bookDesc = value;
            OnPropertyChanged("BookDescription");
        }
    }

    public event PropertyChangedEventHandler? PropertyChanged;

    public void OnPropertyChanged(string name)
    {
        if (this.PropertyChanged != null)
            this.PropertyChanged(this, new PropertyChangedEventArgs(name));
    }
}

NOTE

If you want your data model to respond to property changes, then implement INotifyPropertyChanged interface in your model class.

View Model

Next, create a model repository class with BookInfo collection property initialized with required number of data objects in a new class file as shown in the following code example, and save it as BookInfoRepository.cs file:

public class BookInfoRepository
{
    private ObservableCollection<BookInfo> bookInfo;

    public ObservableCollection<BookInfo> BookInfo
    {
        get { return bookInfo; }
        set { this.bookInfo = value; }
    }

    public BookInfoRepository()
    {
        bookInfo = new ObservableCollection<BookInfo>();
        GenerateBookInfo();
    }

    internal void GenerateBookInfo()
    {
        bookInfo.Add(new BookInfo( "Object-Oriented Programming in C# ", "Object-oriented programming is the de facto programming paradigm" ));
		bookInfo.Add(new BookInfo( "C# Code Contracts", "Code Contracts provide a way to convey code assumptions" ));
		bookInfo.Add(new BookInfo( "Machine Learning Using C#", "You’ll learn several different approaches to applying machine learning" ));
		bookInfo.Add(new BookInfo( "Neural Networks Using C#", "Neural networks are an exciting field of software development" ));
		bookInfo.Add(new BookInfo( "Visual Studio Code", "It is a powerful tool for editing code and serves for end-to-end programming" ));
		bookInfo.Add(new BookInfo( "Android Programming", "It is provides a useful overview of the Android application lifecycle" ));
		bookInfo.Add(new BookInfo( "iOS Succinctly", "It is for developers looking to step into frightening world of iPhone" ));
		bookInfo.Add(new BookInfo( "Visual Studio 2015", "The new version of the widely-used integrated development environment" ));
		bookInfo.Add(new BookInfo( "Xamarin.Forms", "Its creates mappings from its C# classes and controls directly" ));
		bookInfo.Add(new BookInfo( "Windows Store Apps", "Windows Store apps present a radical shift in Windows development" ));
		bookInfo.Add(new BookInfo( "Agile Software Development",  "Learning new development processes can be difficult" ));
		bookInfo.Add(new BookInfo( "Assembly Language", "Assembly language is as close to writing machine code" ));
		bookInfo.Add(new BookInfo( "Cryptography in .NET", "Cryptography is used throughout software to protect all kinds of information" ));
		bookInfo.Add(new BookInfo( "Entity Framework Code First", "Follow author Ricardo Peres as he introduces the newest development mode" ));
		bookInfo.Add(new BookInfo( "Localization for .NET", "Learn to write applications that support different languages and cultures" ));
    }
}

Step 5: Import the ListView namespace

Add the following namespace in your XAML or C#.

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

Step 6: Add a ListView with an item template

Initialize the SfListView and use the ItemsSource property to bind and display a collection of data. By defining the SfListView.ItemTemplate of the SfListView, a custom user interface(UI) can be achieved to display the data items.

<syncfusion:SfListView x:Name="listView" 
                   ItemsSource="{Binding BookInfo}"
                   ItemSize="100">
    <syncfusion:SfListView.ItemTemplate>
        <DataTemplate>
        <Grid Padding="10">
            <Grid.RowDefinitions>
            <RowDefinition Height="0.4*" />
            <RowDefinition Height="0.6*" />
            </Grid.RowDefinitions>
            <Label Text="{Binding BookName}" FontAttributes="Bold" TextColor="Teal" FontSize="21" />
            <Label Grid.Row="1" Text="{Binding BookDescription}" TextColor="Teal" FontSize="15"/>
        </Grid>
        </DataTemplate>
    </syncfusion:SfListView.ItemTemplate>
  </syncfusion:SfListView>
BookInfoRepository viewModel = new BookInfoRepository();
SfListView listView = new SfListView();
listView.ItemSize = 100;
listView.ItemsSource = viewModel.BookInfo;
listView.ItemTemplate = new DataTemplate(() => {
var grid = new Grid();
grid.RowDefinitions.Add(new RowDefinition());
grid.RowDefinitions.Add(new RowDefinition());
var bookName = new Label { FontAttributes = FontAttributes.Bold, BackgroundColor = Colors.Teal, FontSize = 21 };
bookName.SetBinding(Label.TextProperty, new Binding("BookName"));
var bookDescription = new Label { BackgroundColor = Colors.Teal, FontSize = 15 };
bookDescription.SetBinding(Label.TextProperty, new Binding("BookDescription"));
grid.Children.Add(bookName);
grid.Children.Add(bookDescription);
grid.SetRow(bookName, 0);
grid.SetRow(bookDescription, 1);
return grid;
});

The following screenshot illustrates the result of the above code.

.NET MAUI ListView with item template

You can download the ListView Getting Started sample from GitHub.

NOTE

You can refer to our .NET MAUI ListView feature tour page for its groundbreaking feature representations. You can also explore our .NET MAUI ListView example that shows you how to render the ListView in .NET MAUI.