Getting Started with Rich Text Editor in Blazor Web App

This section explains how to add the Blazor Rich Text Editor component in your Blazor Web App using Visual Studio, Visual Studio Code, and the .NET CLI.

Ready to streamline your Blazor development?
Discover the full potential of Blazor components with AI Coding Assistants. Effortlessly integrate, configure, and enhance your projects with intelligent, context-aware code suggestions, streamlined setups, and real-time insights—all seamlessly integrated into your preferred AI-powered IDEs like VS Code, Cursor, CodeStudio and more. Explore AI Coding Assistants

Using .NET CLI Templates

Quickly set up a Blazor application using the preconfigured Syncfusion Web App Template.

First, install the template using the .NET CLI.

dotnet new install Syncfusion.Blazor.WebApp.Templates

Next, create a new project with following command.

dotnet new syncfusionblazorwebapp --name MyApp --interactivity Server --all-interactive Global
dotnet new syncfusionblazorwebapp --name MyApp --interactivity WebAssembly --all-interactive Global
dotnet new syncfusionblazorwebapp --name MyApp --interactivity Auto --all-interactive Global

If you prefer per-page/component interactivity instead of global interactivity, replace --all-interactive Global with --all-interactive PerPage/component (or omit the --all-interactive flag).

After creating the project, navigate to the main project folder (for example, MyApp) and run the following command.

cd MyApp
dotnet run
cd MyApp
dotnet run
cd MyApp
cd MyApp
dotnet run

Manually creating a new Blazor Web App

Create a Blazor Web App using Visual Studio via Microsoft Templates or the Syncfusion® Blazor Extension. For detailed instructions, refer to the Blazor Web App Getting Started documentation.

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

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

Alternatively, create a Blazor Web App using Visual Studio Code via Microsoft Templates, the Syncfusion® Blazor Extension, or the C# Dev Kit extension.

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 the required Blazor packages

Install the Syncfusion.Blazor.RichTextEditor and Syncfusion.Blazor.Themes NuGet packages. All Syncfusion Blazor packages are available on nuget.org. See the NuGet packages topic for details. If using the WebAssembly or Auto render modes in the Blazor Web App, install these packages in the .Client project.

  1. Go to Tools → NuGet Package Manager → Manage NuGet Packages for Solution.
  2. Search the required NuGet packages (Syncfusion.Blazor.RichTextEditor 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.RichTextEditor -Version 34.2.2
Install-Package Syncfusion.Blazor.Themes -Version 34.2.2

Open the terminal and run the following commands.

dotnet add package Syncfusion.Blazor.RichTextEditor -v 34.2.2
dotnet add package Syncfusion.Blazor.Themes -v 34.2.2

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.RichTextEditor namespaces.

@using Syncfusion.Blazor
@using Syncfusion.Blazor.RichTextEditor

Register the Blazor service

Open the Program.cs file in Blazor Web App and register the Blazor service and include the required namespace reference using Syncfusion.Blazor; at the top. 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.

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 at the end of the <head> section in the App.razor file.

<link href="_content/Syncfusion.Blazor.Themes/fluent2.css" rel="stylesheet" />

Include the required script references at the end of the <body> section in the App.razor file to enable Rich Text Editor functionality.

<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>

Add Blazor Rich Text Editor component

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

NOTE

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). If the Interactivity 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.RichTextEditor

<SfRichTextEditor>
    <p>Rich Text Editor allows you to insert images from an online source as well as from a local computer where you want to insert the image in your content.</p>
    <p><b>Get started with the Quick Toolbar to click on the image</b></p>
    <p>It is possible to add a custom style to the selected image inside the Rich Text Editor through the Quick Toolbar.</p>
</SfRichTextEditor>

Run the application

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

Open the terminal and navigate to the main project folder (for example, BlazorWebApp) and run the following command.

cd ..
cd BlazorWebApp
dotnet run
Blazor Rich Text Editor Component

NOTE

View Sample in GitHub.

See also

NOTE

Looking for the full Blazor Rich Text Editor component overview, features, pricing, and documentation? Visit the Blazor Rich Text Editor page.