Getting Started with Blazor Server Side App in Visual Studio

25 Mar 20225 minutes to read

This article provides a step-by-step instructions for building Blazor Server App with Blazor Calendar component using Visual Studio.

Prerequisites

Create a new Blazor Server App in Visual Studio

You can create Blazor Server App using Visual Studio in one of the following ways,

Install Syncfusion Blazor Packages in the App

Syncfusion Blazor components are available in nuget.org. To use Syncfusion Blazor components in the application, add reference to the corresponding NuGet. Refer to NuGet packages topic for available NuGet packages list with component details.

To add Blazor Calendar component in the app, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for Syncfusion.Blazor.Calendars and then install it.

Register Syncfusion Blazor Service

Open ~/_Imports.razor file and import the Syncfusion.Blazor namespace.

@using Syncfusion.Blazor

Now, register the Syncfusion Blazor Service in the Blazor Server App. Here, Syncfusion Blazor Service is registered by setting IgnoreScriptIsolation property as true to load the scripts externally in the next steps.

From 2022 Vol1 (20.1) version - The default value of IgnoreScriptIsolation is changed as true, so, you don’t have to set IgnoreScriptIsolation property explicitly to refer scripts externally.

  • For .NET 6 app, open the ~/Program.cs file and register the Syncfusion Blazor Service.
  • For .NET 5 and .NET 3.X app, open the ~/Startup.cs file and register the Syncfusion Blazor Service.
using Microsoft.AspNetCore.Components;
using Microsoft.AspNetCore.Components.Web;
using Syncfusion.Blazor;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddServerSideBlazor();
builder.Services.AddSyncfusionBlazor(options => { options.IgnoreScriptIsolation = true; });

var app = builder.Build();
....
using Syncfusion.Blazor;

namespace BlazorApplication
{
    public class Startup
    {
        ...
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddRazorPages();
            services.AddServerSideBlazor();
            services.AddSyncfusionBlazor(options => { options.IgnoreScriptIsolation = true; });
        }
        ...
    }
}

Add style sheet

Checkout the Blazor Themes topic to learn different ways (Static Web Assets, CDN and CRG) to refer themes in Blazor application, and to have the expected appearance for Syncfusion Blazor components. Here, the theme is referred using Static Web Assets. Refer to Enable static web assets usage topic to use static assets in your project.

To add theme to the app, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for Syncfusion.Blazor.Themes and then install it. Then, the theme style sheet from NuGet can be referred inside the <head> as follows,

  • ~/Pages/_Host.cshtml file for .NET 5 and .NET 3.X.
  • ~/Pages/_Layout.cshtml for .NET 6.
<head>
    ....
    <link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
</head>
<head>
    ....
    <link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
</head>

Add script reference

Checkout Adding Script Reference topic to learn different ways to add script reference in Blazor Application. In this getting started walk-through, the required scripts are referred using Static Web Assets externally inside the <head> as follows. Refer to Enable static web assets usage topic to use static assets in your project.

  • ~/Pages/_Host.cshtml file for .NET 5 and .NET 3.X.
  • ~/Pages/_Layout.cshtml for .NET 6.
<head>
    ....
    <link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
    <script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>
</head>
<head>
    ....
    <link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
    <script  src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>
</head>

Syncfusion recommends to reference scripts using Static Web Assets, CDN and CRG for better loading performance of the Blazor application.

Add Syncfusion Blazor component

  • Open ~/_Imports.razor file or any razor page under the ~/Pages folder where the component is to be added and import the Syncfusion.Blazor.Calendars namespace.
@using Syncfusion.Blazor
@using Syncfusion.Blazor.Calendars
  • Now, add the Syncfusion Calendar component in razor file. Here, the Calendar component is added in the ~/Pages/Index.razor page under the ~/Pages folder.
<SfCalendar TValue="DateTime" />
  • Press Ctrl+F5 (Windows) or +F5 (macOS) to run the app. Then, the Syncfusion Blazor Calendar component will be rendered in the default web browser.

Blazor Calendar Component

You need to include a valid license key (either paid or trial key) within your applications. Please refer to this help topic for more information.