Getting Started with Blazor Message Component

20 Jan 20239 minutes to read

This section briefly explains how to include the Blazor Message component in your Blazor Server App and Blazor WebAssembly App using Visual Studio.

To get start quickly with Blazor Message component, check on this video:

Prerequisites

Create a new Blazor App in Visual Studio

Create the Blazor Server App or Blazor WebAssembly App using Visual Studio in one of the following ways:

Install Syncfusion Blazor Notifications NuGet in the App

The Syncfusion Blazor components are in nuget.org. To use the Syncfusion Blazor components in the application, add a reference to the corresponding NuGet. Refer to the NuGet packages topic for the available NuGet packages list with component details and Benefits of using individual NuGet packages.

To add the Blazor Message 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.Notifications, then install it.

Register Syncfusion Blazor Service

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

@using Syncfusion.Blazor

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

NOTE

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

Blazor Server App

  • For the .NET 6 app, open the ~/Program.cs file and register the Syncfusion Blazor Service.

  • For the .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();

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

namespace BlazorApplication
{
    public class Startup
    {
        ...
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddRazorPages();
            services.AddServerSideBlazor();
            services.AddSyncfusionBlazor();
        }
        ...
    }
}

Blazor WebAssembly App

Open the ~/Program.cs file and register the Syncfusion Blazor Service in the client web app.

using Microsoft.AspNetCore.Components.Web;
using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
using Syncfusion.Blazor;

var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.RootComponents.Add<App>("#app");
builder.RootComponents.Add<HeadOutlet>("head::after");

builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri(builder.HostEnvironment.BaseAddress) });

builder.Services.AddSyncfusionBlazor();
await builder.Build().RunAsync();
....
using Syncfusion.Blazor;

namespace WebApplication1
{
    public class Program
    {
        public static async Task Main(string[] args)
        {
            ....
            builder.Services.AddSyncfusionBlazor();
            await builder.Build().RunAsync();
        }
    }
}

Add Style Sheet

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

To add a 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, then install it. The theme style sheet from NuGet can be referred as follows.

NOTE

If you are using Syncfusion.Blazor single NuGet, you don’t have to refer to the Syncfusion.Blazor.Themes NuGet. Since style sheets are already inside the assets of the Syncfusion.Blazor NuGet.

Blazor Server App

  • For .NET 6 app, add the Syncfusion bootstrap5 theme in the <head> of the ~/Pages/_Layout.cshtml file.

  • For .NET 3.X, .NET 5 and .NET 7 app, add the Syncfusion bootstrap5 theme in the <head> of the ~/Pages/_Host.cshtml file.

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

Blazor WebAssembly App

For the Blazor WebAssembly App, Refer to the theme style sheet from NuGet in the <head> of the wwwroot/index.html file in the 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

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

Blazor Server App

  • For the .NET 6 app, Refer script in the <head> of the ~/Pages/_Layout.cshtml file.

  • For the .NET 3.X, .NET 5 and .NET 7 app, Refer script in the <head> of the ~/Pages/_Host.cshtml file.

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

Blazor WebAssembly App

For the Blazor WebAssembly App, Refer script in the <head> of the ~/index.html file.

<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 the Static Web Assets, CDN and CRG by disabling JavaScript isolation for better loading performance of the Blazor application.

Add Blazor Message component

  • Open the ~/_Imports.razor file or any other page under the ~/Pages folder where the component is to be added and import the Syncfusion.Blazor.Notifications namespace.
@using Syncfusion.Blazor
@using Syncfusion.Blazor.Notifications
  • Now, add the Syncfusion Message component in the razor file. Here, the Message component is added in the ~/Pages/Index.razor file under the ~/Pages folder.
<SfMessage>Please read the comments carefully</SfMessage>
<style>
    .e-message {
        width: 300px;
    }
</style>
  • Press Ctrl+F5 (Windows) or +F5 (macOS) to run the application. Then, the Syncfusion Blazor Message component will be rendered in the default web browser.

Blazor Message Component