Getting Started with .NET MAUI Button

30 Sep 20246 minutes to read

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

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

Prerequisites

Before proceeding, ensure the following are in place:

  1. Install .NET 7 SDK or later.
  2. Set up a .NET MAUI environment with Visual Studio 2022 (v17.3 or later) or Visual Studio Code. For Visual Studio Code users, ensure that the .NET MAUI workload is installed and configured as described here.

Step 1: Create a New MAUI Project

Visual Studio

  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.

Visual Studio Code

  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 Buttons NuGet Package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for Syncfusion.Maui.Buttons 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 ButtonSample
    {
        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 Button control

    Step 1: Add the NuGet to the project as discussed in the above reference section.

    Step 2: Add the namespace as shown in the following code sample.

    xmlns:buttons="clr-namespace:Syncfusion.Maui.Buttons;assembly=Syncfusion.Maui.Buttons"
    using Syncfusion.Maui.Buttons;

    Initialize Button

    Now, add the SfButton control with a required optimal name using the included namespace.

    <buttons:SfButton x:Name="button" />
    SfButton button = new SfButton();

    Button icon

    The button icon can be defined using the ImageSource and ShowIcon properties of SfButton.

    NOTE

    Ensure that the images mentioned in the code snippets are located in the Resources folder of your sample project.

    <buttons:SfButton x:Name="SfButton" 
                        Text="Button"
                        TextColor="White" 
                        ShowIcon="True" 
                        ImageSource="button_Heart.png"/>
    SfButton button = new SfButton();
    button.Text = "Button";
    button.TextColor = Colors.White;
    button.ImageSource = "button_Heart.png";
    button.ShowIcon = true;

    .NET MAUI Button with button icon.

    Button background image

    The button background image can be defined using the BackgroundImageSource property of SfButton.

    <buttons:SfButton x:Name="SfButton" 
                        Text="Nature"
                        FontAttributes="Bold" 
                        BackgroundImageSource="button_background.png" 
                        CornerRadius="10" 
                        WidthRequest="150"/>
    SfButton button = new SfButton();
    button.Text = "Nature";
    button.FontAttributes = FontAttributes.Bold;
    button.BackgroundImageSource = "button_background.png";
    button.CornerRadius = 10;
    button.WidthRequest = 150;

    .NET MAUI Button with background image.

    Find the complete getting started sample of the .NET MAUI Button from this link.

    NOTE

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