Getting Started with the .NET MAUI Calendar

26 Sep 20246 minutes to read

This section explains how to add the .NET MAUI Calendar control. This section covers only the basic features needed to get started with Syncfusion Calendar. Follow the steps below to add .NET MAUI calendar control to your project.

To get start quickly with our .NET MAUI Calendar, you can check the below video.

Prerequisites

Before proceeding, ensure the following are set up:

  1. Install .NET 7 SDK or later is installed.
  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 .NET 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 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 .NET MAUI Calendar NuGet Package

  1. In Solution Explorer, right-click the project and choose Manage NuGet Packages.
  2. Search for Syncfusion.Maui.Calendar and install the latest version.
  3. Ensure the necessary dependencies are installed correctly, and the project is restored.

Step 3: Register the handler

The 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.

using Syncfusion.Maui.Core.Hosting;
namespace GettingStarted
{
    public static class MauiProgram
    {
        public static MauiApp CreateMauiApp()
        {
            var builder = MauiApp.CreateBuilder();

            builder.ConfigureSyncfusionCore();
            builder
            .UseMauiApp<App>()
            .ConfigureFonts(fonts =>
            {
                fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
            });

            return builder.Build();
        }
    }
}

Step 4: Add .NET MAUI Calendar control

  1. To initialize the control, import the Syncfusion.Maui.Calendar namespace into your code.
  2. Initialize SfCalendar.
<ContentPage   
    . . .
    xmlns:calendar="clr-namespace:Syncfusion.Maui.Calendar;assembly=Syncfusion.Maui.Calendar">

    <calendar:SfCalendar />
</ContentPage>
using Syncfusion.Maui.Calendar;
. . .

public partial class MainPage : ContentPage
{
    public MainPage()
    {
        InitializeComponent();
        SfCalendar calendar = new SfCalendar();
        this.Content = calendar;
    }
}

Change different calendar views

The .NET MAUI Calendar control provides four different types of views to display dates, and it can be assigned to the control using the View property. By default, the control is assigned to the Month view. Initially, all Calendar views will show the current date.

<calendar:SfCalendar  x:Name="calendar" 
                        View="Month">
</calendar:SfCalendar>
this.calendar.View = CalendarView.Month;

Change different calendar views in .NET MAUI Calendar.

Change first day of week

The Calendar control is rendered with Sunday as the first day of the week and it allows customization to change the first day of the week using the FirstDayOfWeek property in month view.

The following code explains how to show the Calendar with Monday as the first day of the week.

<calendar:SfCalendar x:Name="calendar">
    <calendar:SfCalendar.MonthView>
        <calendar:CalendarMonthView FirstDayOfWeek="Monday"/>
    </calendar:SfCalendar.MonthView>
 </calendar:SfCalendar>
this.calendar.MonthView.FirstDayOfWeek = DayOfWeek.Monday;

Change first day of week in .NET MAUI Calendar.

Date selection

The Calendar allows the user to select a single date, multiple dates, or a range of dates by interaction or programmatic selection. The default selection mode is Single.

The selection details can be obtained by using the SelectionChanged event of the calendar. It returns CalendarSelectionChangedEventArgs, which holds the details about the selected date or range.

The following code explains how to show the Calendar with Multiple as the Selection mode.

<calendar:SfCalendar  x:Name="calendar" 
                      SelectionMode="Multiple">
</calendar:SfCalendar>
this.calendar.SelectionMode = CalendarSelectionMode.Multiple;

Change selection mode in .NET MAUI Calendar.

Corner radius

You can customize the corner radius of the calendar using the CornerRadius property of the SfCalendar, allowing you to set the desired roundness for the corners of the calendar. The default value of the CornerRadius property is 20.

<calendar:SfCalendar x:Name="calendar" 
                     View="Month"
                     CornerRadius="15">
 </calendar:SfCalendar>
this.calendar.CornerRadius = 15;

Change corner radius in .NET MAUI Calendar.

NOTE

You can also explore our .NET MAUI Calendar Example that shows you how to render the Calendar in .NET MAUI.