Getting Started with .NET MAUI Avatar View

This section guides you through setting up and configuring a AvatarView 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.

• Visual Studio
• Visual Studio Code
• JetBrains Rider

Prerequisites

Before proceeding, ensure the following are set up:

1. Install .NET 8 SDK or later is installed.
2. Set up a .NET MAUI environment with Visual Studio 2022 (v17.3 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.

Step 3: Register the handler

Syncfusion.Maui.Core NuGet is a dependent package for all Syncfusion^® controls of .NET MAUI. In the MauiProgram.cs file, register the handler for Syncfusion^® core.

C#

using Microsoft.Maui;
using Microsoft.Maui.Hosting;
using Microsoft.Maui.Controls.Compatibility;
using Microsoft.Maui.Controls.Hosting;
using Microsoft.Maui.Controls.Xaml;
using Syncfusion.Maui.Core.Hosting;

namespace AvatarViewSample
{
  public static class MauiProgram
  {
	public static MauiApp CreateMauiApp()
	{
		var builder = MauiApp.CreateBuilder();
		builder
		.UseMauiApp<App>()
		.ConfigureSyncfusionCore()
		.ConfigureFonts(fonts =>
		{
			fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
		});

		return builder.Build();
	 }
   
  }

}

Step 4: Add a Basic Avatar View

1. To initialize the control, import the Core namespace into your code.
2. Initialize SfAvatarView.

XAML

<ContentPage
    . . .    
    xmlns:sfavatar="clr-namespace:Syncfusion.Maui.Core;assembly=Syncfusion.Maui.Core">
    <Grid>
        <sfavatar:SfAvatarView />
    </Grid>
</ContentPage>

C#

using Syncfusion.Maui.Core;
    namespace AvatarViewGettingStarted
    {
        public partial class MainPage : ContentPage
        {
            public MainPage()
            {
                InitializeComponent();           
                SfAvatarView avatarView = new SfAvatarView();
            }
        }   
    }

Prerequisites

Before proceeding, ensure the following are set up:

1. Install .NET 8 SDK or later is installed.
2. Set up a .NET MAUI environment with Visual Studio Code.
3. Ensure that the .NET MAUI extension is 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^® 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.

Step 3: Register the handler

Syncfusion.Maui.Core NuGet is a dependent package for all Syncfusion^® controls of .NET MAUI. In the MauiProgram.cs file, register the handler for Syncfusion^® core.

C#

using Microsoft.Maui;
using Microsoft.Maui.Hosting;
using Microsoft.Maui.Controls.Compatibility;
using Microsoft.Maui.Controls.Hosting;
using Microsoft.Maui.Controls.Xaml;
using Syncfusion.Maui.Core.Hosting;

namespace AvatarViewSample
{
  public static class MauiProgram
  {
	public static MauiApp CreateMauiApp()
	{
		var builder = MauiApp.CreateBuilder();
		builder
		.UseMauiApp<App>()
		.ConfigureSyncfusionCore()
		.ConfigureFonts(fonts =>
		{
			fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
		});

		return builder.Build();
	 }
   
  }

}

Step 4: Add a Basic Avatar View

1. To initialize the control, import the Core namespace into your code.
2. Initialize SfAvatarView.

XAML

<ContentPage
    . . .    
    xmlns:sfavatar="clr-namespace:Syncfusion.Maui.Core;assembly=Syncfusion.Maui.Core">
    <Grid>
        <sfavatar:SfAvatarView />
    </Grid>
</ContentPage>

C#

using Syncfusion.Maui.Core;
    namespace AvatarViewGettingStarted
    {
        public partial class MainPage : ContentPage
        {
            public MainPage()
            {
                InitializeComponent();           
                SfAvatarView avatarView = new SfAvatarView();
            }
        }   
    }

Prerequisites

Before proceeding, ensure the following are set up:

1. Ensure you have the latest version of JetBrains Rider.
2. Install .NET 8 SDK or later is installed.
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 the handler

Syncfusion.Maui.Core NuGet is a dependent package for all Syncfusion^® controls of .NET MAUI. In the MauiProgram.cs file, register the handler for Syncfusion^® core.

C#

using Microsoft.Maui;
using Microsoft.Maui.Hosting;
using Microsoft.Maui.Controls.Compatibility;
using Microsoft.Maui.Controls.Hosting;
using Microsoft.Maui.Controls.Xaml;
using Syncfusion.Maui.Core.Hosting;

namespace AvatarViewSample
{
  public static class MauiProgram
  {
	public static MauiApp CreateMauiApp()
	{
		var builder = MauiApp.CreateBuilder();
		builder
		.UseMauiApp<App>()
		.ConfigureSyncfusionCore()
		.ConfigureFonts(fonts =>
		{
			fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
		});

		return builder.Build();
	 }
   
  }

}

Step 4: Add a Basic Avatar View

1. To initialize the control, import the Core namespace into your code.
2. Initialize SfAvatarView.

XAML

<ContentPage
    . . .    
    xmlns:sfavatar="clr-namespace:Syncfusion.Maui.Core;assembly=Syncfusion.Maui.Core">
    <Grid>
        <sfavatar:SfAvatarView />
    </Grid>
</ContentPage>

C#

using Syncfusion.Maui.Core;
    namespace AvatarViewGettingStarted
    {
        public partial class MainPage : ContentPage
        {
            public MainPage()
            {
                InitializeComponent();           
                SfAvatarView avatarView = new SfAvatarView();
            }
        }   
    }

Adding a image in .NET MAUI Avatar View

You can add a custom image for displaying in .NET MAUI Avatar View using the ImageSource property. And set the ContentType to Custom. To ensure the avatar image appears correctly, place the image in the Resources/Images directory.

XAML

<ContentPage.Content>
<Grid>
    <sfavatar:SfAvatarView ContentType="Custom"
                           ImageSource="alex.png"
                           VerticalOptions="Center"
                           HorizontalOptions="Center"   
                           HeightRequest="50"
                           CornerRadius="25"
                           WidthRequest="50" 
                           Stroke="Black"
                           StrokeThickness="1"/>
</Grid>
</ContentPage.Content>

C#

using Syncfusion.Maui.Core;

namespace AvatarViewGettingStarted
{
    public partial class MainPage : ContentPage
    {
        public MainPage()
        {
            InitializeComponent();
            
	        //main grid
            Grid mainGrid = new Grid();

            // Create an SfAvatarView control.
            SfAvatarView avatarView = new SfAvatarView();
            avatarView.VerticalOptions = LayoutOptions.Center;
            avatarView.HorizontalOptions = LayoutOptions.Center;
            avatarView.ContentType = ContentType.Custom;
            avatarView.ImageSource = "alex.png";
            avatarView.WidthRequest = 50;
            avatarView.HeightRequest = 50;
            avatarView.CornerRadius = 25;
            avatarView.Stroke = Colors.Black;
            avatarView.StrokeThickness = 1;
            mainGrid.Children.Add(avatarView);
            this.Content = mainGrid;
        }
    }
}

The following screenshot illustrates the result of the above code.

The Getting Started sample of .NET MAUI Avatar View is available in this following link: Getting Started.

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.