Getting Started with Blazor Calendar Component in Blazor Server App

18 Nov 20186 minutes to read

This section briefly explains how to include the Blazor Calendar component in a Blazor Server App using Visual Studio, Visual Studio Code, and the .NET CLI.

Create a new Blazor Server App

Create a Blazor Server App by using the Blazor Web App template in Visual Studio via Microsoft Templates or the Blazor Extension.

Run the following command to create a new Blazor Server App.

Terminal

dotnet new blazor -o BlazorApp --interactivity Server
cd BlazorApp

Alternatively, create a Blazor Server App using Visual Studio Code via Microsoft Templates or the Blazor Extension, or the C# Dev Kit extension.

Run the following command to create a new Blazor Server App.

Command Prompt

dotnet new blazor -o BlazorApp --interactivity Server
cd BlazorApp

NOTE

Configure the appropriate Interactive render mode and Interactivity location while creating a Blazor Server App. For detailed information, refer to the interactive render mode documentation.

Install the required Blazor packages

Install the Syncfusion.Blazor.Calendars and Syncfusion.Blazor.Themes NuGet packages. All Syncfusion Blazor packages are available on nuget.org. See the NuGet packages topic for details.

Go to Tools → NuGet Package Manager → Manage NuGet Packages for Solution.
Search the required NuGet packages (Syncfusion.Blazor.Calendars and Syncfusion.Blazor.Themes) and install them.

Alternatively, you can install the same packages using the Package Manager Console with the following commands.

Package Manager Console

Install-Package Syncfusion.Blazor.Calendars -Version 34.1.29
Install-Package Syncfusion.Blazor.Themes -Version 34.1.29

Open the terminal and run the following commands.

Terminal

dotnet add package Syncfusion.Blazor.Calendars -v 34.1.29
dotnet add package Syncfusion.Blazor.Themes -v 34.1.29

Open the command prompt and run the following commands.

Command Prompt

dotnet add package Syncfusion.Blazor.Calendars -v 34.1.29
dotnet add package Syncfusion.Blazor.Themes -v 34.1.29

Add import namespaces

After the packages are installed, open the ~/_Imports.razor file and import the Syncfusion.Blazor and Syncfusion.Blazor.Calendars namespaces.

~/_Imports.razor
@using Syncfusion.Blazor
@using Syncfusion.Blazor.Calendars

Register the Blazor service

Open the Program.cs file in the Blazor Server App and register the Blazor service.

Program.cs
....
using Syncfusion.Blazor;
....
builder.Services.AddSyncfusionBlazor();
....

Add stylesheet and script resources

The theme stylesheet and script can be accessed from NuGet through Static Web Assets. Include the stylesheet and the script references in the App.razor file.

App.razor
...
<link href="_content/Syncfusion.Blazor.Themes/fluent2.css" rel="stylesheet" />
...
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>

Add Blazor Calendar component

Open a Razor file located in the ~/Pages/*.razor (for example, Home.razor) and add the Blazor Calendar component inside the Razor file.

NOTE

If the interactivity location is set to Per page/component, define a render mode at the top of the Razor file (for example, InteractiveServer). If the Interactivity is set to Global, the render mode is automatically configured in the App.razor file by default.

Home.razor
@rendermode InteractiveServer

<SfCalendar TValue="DateTime"></SfCalendar>

Run the application

Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. The Blazor Calendar component will render in your default web browser.

Open the terminal and run the following command.

Terminal

dotnet run

Open the command prompt and run the following command.

Command Prompt

dotnet run

NOTE

View Sample in GitHub.

Setting the Value, Min, and Max dates

The Calendar component provides an option to select a date within a specified range by defining the Min and Max properties. You can also set a date value within a specific range using the Value property. For more information, refer to the Date Range section. Min and Max are inclusive boundaries; out-of-range dates are disabled.

Here, the Calendar allows selecting a date from the 5th through the 27th of the current month. TValue specifies the type of the Calendar component.

Home.razor
@using Syncfusion.Blazor.Calendars

<SfCalendar TValue="DateTime" Min='@MinDate' Value='@DateValue' Max='@MaxDate'></SfCalendar>

@code
{
    public DateTime MinDate {get;set;} = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 05);
    public DateTime MaxDate {get;set;} = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 27);
    public DateTime DateValue {get;set;} = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 15);
}