Getting Started with .NET MAUI Chips

29 Jun 20266 minutes to read

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

To quickly get started with the .NET MAUI Chips, watch this video.

Prerequisites

Before proceeding, ensure the following are in place:

  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 Core NuGet package

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

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

Now, define a simple data model of person with the name properties.

public class Person 
{ 
	public string Name 
	{
		get;
		set;
	} 
}

Next, create a view model class and initialize a collection of persons as shown in the following code sample.

public class ViewModel : INotifyPropertyChanged
{
	private ObservableCollection<Person> employees; 
	public ObservableCollection<Person> Employees 
	{
		get { return employees; } 
		set { Employees = value; OnPropertyChanged("Employees"); }
	}

	public ViewModel()
	{
		employees = new ObservableCollection<Person>();
		employees.Add(new Person() { Name = "John" });
		employees.Add(new Person() { Name = "James" });
		employees.Add(new Person() { Name = "Linda" });
		employees.Add(new Person() { Name = "Rose" });
		employees.Add(new Person() { Name = "Mark" });
	} 

	public event PropertyChangedEventHandler PropertyChanged;

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

Step 5: Import the Chips namespace

Add the following namespace in your XAML or C#.

xmlns:chip="clr-namespace:Syncfusion.Maui.Core;assembly=Syncfusion.Maui.Core"
using Syncfusion.Maui.Core;

Step 6: Add the Chips component

Create an instance for the Chips control. Create an instance of ViewModel class,and then set it as the BindingContext. Bind the ItemsSource property with a collection, and then set the DisplayMemberPath property:

<chip:SfChipGroup ItemsSource="{Binding Employees}" 
				  ChipPadding="8,8,0,0" 
				  DisplayMemberPath="Name"
				  ChipBackground="white"
				  ChipTextColor="Black"
				  HorizontalOptions="Start" 
				  VerticalOptions="Center">
	<chip:SfChipGroup.BindingContext>
		<local:ViewModel x:Name="viewModel"/>
	</chip:SfChipGroup.BindingContext>
</chip:SfChipGroup>
this.BindingContext = new ViewModel();
SfChipGroup chipGroup = new SfChipGroup()
{
	DisplayMemberPath = "Name",
	HorizontalOptions = LayoutOptions.Start,
	VerticalOptions = LayoutOptions.Center,
	ChipTextColor = Colors.Black,
	ChipBackground = Colors.White,
	ChipPadding = new Thickness(8, 8, 0, 0),
};
chipGroup.SetBinding(SfChipGroup.ItemsSourceProperty, "Employees");

The following screenshot illustrates the result of the above code.

ChipGroup sample with display member path and itemsSource demo

You can download the Chips Getting Started sample from GitHub

NOTE

When publishing in AOT mode on iOS, ensure [Preserve(AllMembers = true)] is added to the model class to maintain DisplayMemberPath binding

NOTE

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