Getting Started with Blazor Block Editor Component in Blazor WASM App

26 Jun 20269 minutes to read

The Blazor Block Editor is a modular, block-based content editor component that enables rich, structured content creation. It provides an intuitive interface for building documents and articles content using customizable blocks such as headings, paragraphs, lists, and more. The WebAssembly deployment model allows the editor to run entirely in the browser, providing a responsive client-side experience.

This section explains how to integrate the Blazor Block Editor component into a Blazor WebAssembly App using Visual Studio, Visual Studio Code, and the .NET CLI.

Create a new Blazor WebAssembly (Standalone) App

Create a Blazor WebAssembly App using Visual Studio via Microsoft Templates or the Blazor Extension.

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

dotnet new blazorwasm -o BlazorApp
cd BlazorApp

Alternatively, create a Blazor WebAssembly 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 WebAssembly App.

dotnet new blazorwasm -o BlazorApp
cd BlazorApp

Install the required Blazor packages

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

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

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

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

Open the terminal and run the following commands.

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

Open the command prompt and run the following commands.

dotnet add package Syncfusion.Blazor.BlockEditor -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.BlockEditor namespaces.

@using Syncfusion.Blazor
@using Syncfusion.Blazor.BlockEditor

Register the Blazor service

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

....
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 script references in the ~wwwroot/index.html 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>

Add Blazor Block Editor component

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

@using Syncfusion.Blazor.BlockEditor

<SfBlockEditor @bind-Blocks="blockDataOverview"> </SfBlockEditor>

@code 
{
private List<BlockModel> blockDataOverview = new EditorBlockData().GetBlockDataOverview();
public class EditorBlockData
{
    public List<BlockModel> GetBlockDataOverview()
    {
        List<BlockModel> blockDataOverview = new List<BlockModel>
        {
            new BlockModel
            {
                BlockType = BlockType.Heading,
                Properties = new HeadingBlockSettings { Level = 2 },
                Content =
                {
                    new ContentModel
                    {
                        ContentType = ContentType.Text,
                        Content = "Getting Started with Block Editor"
                    }
                }
            },
            new BlockModel
            {
                BlockType = BlockType.Paragraph,
                Content =
                {
                    new ContentModel { ContentType = ContentType.Text, Content = "Welcome to" },
                    new ContentModel
                    {
                        ContentType = ContentType.Text,
                        Content = " Block Editor",
                        Properties = new TextContentSettings
                        {
                            Styles = new StyleModel { Bold = true }
                        }
                    },
                    new ContentModel
                    {
                        ContentType = ContentType.Text,
                        Content = " - your flexible, modular workspace for creating rich, structured content. Whether you're drafting documents, brainstorming ideas, or collaborating with your team, Block Editor makes it simple and intuitive."
                    }
                }
            },
            new BlockModel
            {
                BlockType = BlockType.Paragraph,
                Content = new List<ContentModel>()
            }
        };

        return blockDataOverview;
    }
}
}

Run the application

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

Open the terminal and run the following command.

dotnet run

Open the command prompt and run the following command.

dotnet run
Blazor Block Editor Default.

NOTE

View Sample in GitHub