Getting Started with Blazor Dialog Component in Blazor Web App

22 Jun 20269 minutes to read

This section briefly explains about how to include Blazor Dialog component in your Blazor Web App using Visual Studio, Visual Studio Code, and the .NET CLI.

dotnet new blazor -o BlazorWebApp -int Auto
cd BlazorWebApp
cd BlazorWebApp.Client

dotnet --version

dotnet new blazor -o BlazorWebApp -int Auto
cd BlazorWebApp
cd BlazorWebApp.Client

NOTE

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

Install required Blazor packages

Install the Syncfusion.Blazor.Popups and Syncfusion.Blazor.Themes NuGet packages using one of the following methods.

Visual Studio (NuGet Package Manager):

1. Go to Tools → NuGet Package Manager → Manage NuGet Packages for Solution.
2. Search the required NuGet packages (Syncfusion.Blazor.Popups and Syncfusion.Blazor.Themes) and install it.

Visual Studio Code or .NET CLI:

Open the terminal or command prompt and run the following commands:

dotnet add package Syncfusion.Blazor.Popups -v 33.2.3
dotnet add package Syncfusion.Blazor.Themes -v 33.2.3

If using the WebAssembly or Auto render modes in the Blazor Web App, install these packages in the client project.

NOTE

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

Add import namespaces

After the packages are installed, open the ~/_Imports.razor file in the client project and import the Syncfusion.Blazor and Syncfusion.Blazor.Popups namespaces.

@using Syncfusion.Blazor
@using Syncfusion.Blazor.Popups

Register Blazor service

Register the Blazor service in the Program.cs file of your Blazor Web App.

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

NOTE

If the Interactive Render Mode is set to WebAssembly or Auto, register the Blazor service in Program.cs files of both the server and client projects in your Blazor Web App.

Add stylesheet and script resources

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

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

NOTE

Check out the Blazor Themes topic to discover various methods (Static Web Assets, CDN, and CRG) for referencing themes in your Blazor application. Also, check out the Adding Script Reference topic to learn different approaches for adding script references in your Blazor application.

Add Blazor Dialog component

• Open a Razor file located in the ~/Components/Pages (for example, Home.razor) and add the Blazor Dialog component inside the razor file.
• If the interactivity location is set to Per page/component in the Web App, define a render mode at the top of the razor file. (For example, InteractiveServer, InteractiveWebAssembly or InteractiveAuto).

NOTE

If the Interactivity Location is set to Global with Auto or WebAssembly, the render mode is automatically configured in the App.razor file by default.

@rendermode InteractiveAuto
@using Syncfusion.Blazor.Popups

<SfDialog Width="250px">
 <DialogTemplates>
 <Content> This is a Dialog with content </Content>
 </DialogTemplates>
</SfDialog>

Run the application

Visual Studio:

• Press + (Windows) or + (macOS) to launch the application. The Blazor Dialog component will render in your default web browser.

Visual Studio Code or .NET CLI:

1. Open the terminal (Visual Studio Code) or command prompt (.NET CLI) and navigate to the Client project folder.

2. Run the following command:

    dotnet run
   

3. The application will start and display in your default web browser.

NOTE

• In the dialog control, max-height is calculated based on the dialog target element height. If the Target property is not configured, the document.body is considered as a target. Therefore, to show a dialog in proper height, you need to add min-height to the target element.

NOTE

• If the dialog is rendered based on the body, then the dialog will get the height based on its body element height. If the height of the dialog is larger than the body height, then the dialog’s height will not be set. For this scenario, you can set the CSS style for the html and body to get the dialog height.

html, body {
 height: 100%;
}

Created and Destroyed Events

• The Created event fires when the dialog is initialized and rendered in the DOM.

• The Destroyed event triggers when the dialog component is removed from the DOM. These lifecycle events allow executing custom code at specific points in the component’s existence.

@using Syncfusion.Blazor.Popups

<SfDialog>
 <DialogEvents Created="@CreatedHandler" Destroyed="@DestroyedHandler"></DialogEvents>
</SfDialog>
@code {

 public void CreatedHandler(Object args)
 {
 // Here, you can customize your code.
 }

 private void DestroyedHandler()
 {
 // Here, you can customize your code.
 }
}

Prerender the Dialog

The AllowPrerender property controls how the dialog DOM elements are handled when the dialog is hidden. Understanding this property is crucial for optimizing performance in your application.

• By default, AllowPrerender is set to false. In this mode, dialog DOM elements are completely removed from the DOM when the dialog is hidden, and recreated each time the dialog is shown. This approach saves memory but requires re-rendering on each display.
• When AllowPrerender is set to true, the dialog elements remain in the DOM even when hidden, which improves performance for frequently accessed dialogs but uses more memory.

@using Syncfusion.Blazor.Popups
@using Syncfusion.Blazor.Buttons

<div id="target">
 <div>
 <button class="e-btn" @onclick="@OnBtnClick">Open</button>
 </div>
 <SfDialog Target="#target" Width="300px" ShowCloseIcon="true" @bind-Visible="Visibility" AllowPrerender="true" Header="AllowPrerender Dialog" Content="This is a dialog with content">
 </SfDialog>
</div>
<style>
 #target {
 height: 500px;
 }
</style>
@code {
 private bool Visibility { get; set; } = false;
 private void OnBtnClick()
 {
 this.Visibility = true;
 }
}

Set Header to Dialog

The Header property allows rendering a dialog with custom text header.

@using Syncfusion.Blazor.Popups

<SfDialog Width="250px" Header="Dialog Header"></SfDialog>

Set Content to Dialog

The Content property allows rendering a dialog with custom text content.

@using Syncfusion.Blazor.Popups

<SfDialog Width="250px" Content="This is a dialog with Content property."></SfDialog>

NOTE

View Sample in GitHub.

See also

1. Getting Started with Blazor Web Assembly App in Visual Studio or .NET CLI
2. Getting Started with Blazor Web App in Visual Studio or .NET CLI