Getting Started with .NET MAUI Avatar View

29 Jun 20265 minutes to read

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

To quickly get started with the .NET MAUI Avatar View, 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 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, 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: Import the Avatar View namespace

Add the following namespace in your XAML or C#.

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

Step 5: Add the Avatar View component

Create an instance for the Avatar View control, and add it as content. You can add a custom image to display in the .NET MAUI Avatar View using the ImageSource property. Set the ContentType to Custom. To ensure the avatar image appears correctly, place the image in the Resources/Images directory.

<sfavatar:SfAvatarView ContentType="Custom"
                       ImageSource="alex.png"
                       VerticalOptions="Center"
                       HorizontalOptions="Center"   
                       HeightRequest="100"
                       CornerRadius="50"
                       WidthRequest="100" 
                       Stroke="Black"
                       StrokeThickness="2"/>
SfAvatarView avatarView = new SfAvatarView();
avatarView.VerticalOptions = LayoutOptions.Center;
avatarView.HorizontalOptions = LayoutOptions.Center;
avatarView.ContentType = ContentType.Custom;
avatarView.ImageSource = "alex.png";
avatarView.WidthRequest = 100;
avatarView.HeightRequest = 100;
avatarView.CornerRadius = 50;
avatarView.Stroke = Colors.Black;
avatarView.StrokeThickness = 2;

The following screenshot illustrates the result of the above code.

.NET MAUI Avatar View

You can download the Avatar View Getting Started sample from GitHub

NOTE

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