Getting started with Blazor ASP.NET Core Hosted App in .NET CLI
10 Feb 20237 minutes to read
This articles provides a step-by-step instructions for building Blazor ASP.NET Core Hosted WebAssembly application with Blazor Calendar
components using .NET CLI.
Prerequisites
Latest version of the .NET Core SDK. If you previously installed the SDK, you can determine the installed version by executing the following command in a command prompt (Windows) or terminal (macOS) or command shell (Linux).
dotnet --version
Create a Blazor ASP.NET Core Hosted WebAssembly project using .NET CLI
Run the dotnet new blazorwasm
command with option -ho
or --hosted
to create a new Blazor ASP.NET Core Hosted WebAssembly application in the command prompt (Windows) or terminal (macOS) or command shell (Linux).
dotnet new blazorwasm -o BlazorApp --hosted
cd BlazorApp
This command creates new Blazor WebAssembly App project and places it in a new directory called BlazorApp inside your current location. See Create Blazor App topic and dotnet new CLI command topics for more details.
NOTE
If you have installed multiple SDK versions and need any specific framework version (net5.0/netcoreapp3.1) project, then add
-f
flag along withdotnet new blazorwasm
comment. Refer here for the available options.
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 and Benefits of using individual NuGet packages.
Add Syncfusion.Blazor.Calendars
NuGet package to the application using the following command in the command prompt (Windows) or terminal (Linux and macOS) to install a NuGet package. See Install and manage packages using the dotnet CLI topics for more details.
cd client
dotnet add package Syncfusion.Blazor.Calendars --version 21.1.35
dotnet restore
Register Syncfusion Blazor Service
Open ~/_Imports.razor file and import the Syncfusion.Blazor
namespace.
@using Syncfusion.Blazor
Now, Open the ~/Program.cs file and register the Syncfusion Blazor Service in the client web app. Here, Syncfusion Blazor Service is registered by setting IgnoreScriptIsolation property as true
to load the scripts externally in the next steps.
NOTE
From 2022 Vol-1 (20.1) version, the default value of
IgnoreScriptIsolation
is changed totrue
. It is not necessary to set theIgnoreScriptIsolation
property to refer scripts externally, since the default value has already been changed to true, and this property is obsolete.
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();
var app = builder.Build();
....
using Syncfusion.Blazor;
namespace BlazorApp.Client
{
public class Program
{
public static async Task Main(string[] args)
{
....
....
builder.Services.AddSyncfusionBlazor();
await builder.Build().RunAsync();
}
}
}
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, Add Syncfusion.Blazor.Themes
NuGet package to the application using the following command in the command prompt (Windows) or terminal (Linux and macOS) to install the NuGet package.
NOTE
If you are using Syncfusion.Blazor single NuGet, you don’t have to refer Syncfusion.Blazor.Themes NuGet. Since style sheets already inside the assets of
Syncfusion.Blazor
NuGet.
dotnet add package Syncfusion.Blazor.Themes --version 21.1.35
dotnet restore
Then the theme style from can be referred inside the <head>
of the wwwroot/index.html file in client web app.
<head>
...
<link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
<!--Refer theme style sheet as below if you are using Syncfusion.Blazor Single NuGet-->
<!--<link href="_content/Syncfusion.Blazor/styles/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>
of wwwroot/index.html file in client web app. Refer to Enable static web assets usage topic to use static assets in your project.
<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>
<!--Use below script reference if you are using Syncfusion.Blazor Single NuGet-->
<!--<script src="_content/Syncfusion.Blazor/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>-->
</head>
NOTE
Syncfusion recommends to reference scripts using Static Web Assets, CDN and CRG by disabling JavaScript isolation 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 theSyncfusion.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" />
- In the command prompt (Windows) or terminal (Linux and macOS) to run the following command to build and start the app. The app listening on
http://localhost:<port number>
and view it in the browser.
dotnet run
NOTE
For Blazor ASP.NET Core Hosted WebAssembly application, the
Server
[BlazorApp.Server] project should be the startup project.
NOTE
You need to include a valid license key (either paid or trial key) within your applications. Refer to this help topic for more information.