How can I help you?
Getting Started with Blazor Block Editor Component
19 May 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, articles, and collaborative 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 Syncfusion® Blazor Block Editor component into a Blazor WebAssembly App using Visual Studio, Visual Studio Code, and the .NET CLI.
Prerequisites
Create a new Blazor App in Visual Studio
Create a Blazor WebAssembly App using Visual Studio via the Microsoft Templates or the Syncfusion® Blazor Extension. For detailed instructions, refer to the Blazor WASM App Getting Started documentation.
Prerequisites
Create a new Blazor App in Visual Studio Code
Create a Blazor WebAssembly App using Visual Studio Code via the Microsoft Templates or the Syncfusion® Blazor Extension. For detailed instructions, refer to the Blazor WASM App Getting Started documentation.
Alternatively, create a WebAssembly application by using the following command in the integrated terminal (Ctrl+`):
dotnet new blazorwasm -o BlazorApp
cd BlazorAppPrerequisites
Install the latest version of .NET SDK. If the .NET SDK is already installed, determine the installed version by running the following command in a command prompt (Windows), terminal (macOS), or command shell (Linux).
dotnet --versionCreate a Blazor WebAssembly App using .NET CLI
Run the following command to create a new Blazor WebAssembly App in a command prompt (Windows) or terminal (macOS/Linux). For detailed instructions, refer to the Blazor WASM App Getting Started documentation.
dotnet new blazorwasm -o BlazorApp
cd BlazorAppInstall Syncfusion® Blazor packages
Install Syncfusion.Blazor.BlockEditor and Syncfusion.Blazor.Themes NuGet packages in your project using the NuGet Package Manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), or the integrated terminal in Visual Studio Code (dotnet add package), or the .NET CLI.
Alternatively, run the following commands in the Package Manager Console to achieve the same.
Install-Package Syncfusion.Blazor.BlockEditor -Version 33.2.3
Install-Package Syncfusion.Blazor.Themes -Version 33.2.3NOTE
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 and import the Syncfusion.Blazor and Syncfusion.Blazor.BlockEditor namespaces.
@using Syncfusion.Blazor
@using Syncfusion.Blazor.BlockEditorRegister Syncfusion® Blazor service
Register the Syncfusion® Blazor service in the Program.cs file of your Blazor WebAssembly App.
....
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 ~/index.html file.
<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>NOTE
Check out the Blazor Themes topic to discover various methods (Static Web Assets, CDN, and CRG) for referencing themes in the Blazor application. Also, check out the Adding Script Reference topic to learn different approaches for adding script references in the Blazor application.
Add Syncfusion® Blazor Block Editor component
Add the Syncfusion® Blazor Block Editor component in the ~/Pages/Index.razor file and configure the initial blocks using the Blocks property.
@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;
}
}
```
}To launch the application, press Ctrl+F5 in Visual Studio, run dotnet run from the CLI or integrated terminal in VS Code, or use the Run command in your preferred IDE to render the Syncfusion® Blazor Block Editor component in the default web browser.
NOTE