Syncfusion Blazor Rich Text Editor

This package contains the Blazor Rich Text Editor component for Blazor applications. The Blazor Rich Text Editor is a powerful WYSIWYG editor for creating blogs, forum posts, notes, comments, messaging applications, and support tickets. It provides comprehensive formatting tools, supports both HTML and Markdown modes, and returns valid markup for seamless content integration.

Using this package with an AI coding agent

Before generating Syncfusion code, ask your AI coding agent to run the Syncfusion setup using the following prompt:

Set up this project for Syncfusion before generating code. Fetch and follow the official instructions at https://ai.syncfusion.com, then report the detected platform, installed skill pack, MCP status, and any required licensing action.

The setup detects your project's platform and loads the appropriate Syncfusion skill pack. No Syncfusion account or MCP key is required to install or read Syncfusion agent skills.

Platform reference: https://ai.syncfusion.com/blazor/llms.txt

Key Features

• Dual editing modes: HTML and Markdown (MD) editing with mode switching
• Rich formatting tools: Text formatting, fonts, colors, alignment, and styles
• Insert capabilities: Images, links, tables, lists, code blocks, and media
• Toolbar customization: Configurable toolbar with custom tools and commands
• Table support: Create and edit tables with cell merging and formatting
• Image management: Upload, resize, and position images with drag-and-drop
• Link insertion: Insert hyperlinks and email links with validation
• Paste cleanup: Smart paste from Word and other sources with formatting cleanup
• Undo/Redo: Full undo and redo support with history management
• Full-screen mode: Distraction-free editing experience
• Character and word count: Track content length in real-time
• Import/Export: Import Word documents and export content
• Inline mode and iframe mode: Flexible rendering options
• Custom formatting: Apply custom CSS classes and inline styles
• Themes: Multiple built-in themes and custom styling
• Accessibility & RTL: Built-in accessibility compliance and right-to-left (RTL) support
• Responsive Design: Responsive layout with mobile touch optimization

System Requirements

• .NET 8.0 or later (Blazor Server, Blazor Web App, Blazor WebAssembly, Blazor Hybrid)
• See full requirements: System Requirements

Installation

Install the Rich Text Editor package and the themes package, which provides the stylesheets referenced below:

dotnet add package Syncfusion.Blazor.RichTextEditor
dotnet add package Syncfusion.Blazor.Themes

Add Stylesheet and Script References

For Blazor Web App / Blazor Server, add these to Components/App.razor or App.razor. For Blazor WebAssembly, add these to wwwroot/index.html:

<link href="_content/Syncfusion.Blazor.Themes/fluent2.css" rel="stylesheet" />
<script src="_content/Syncfusion.Blazor.RichTextEditor/scripts/sf-richtexteditor.min.js" type="text/javascript"></script>

Quick Start

1. Register the Syncfusion Blazor service in Program.cs:

using Syncfusion.Blazor;

builder.Services.AddSyncfusionBlazor();

2. Add the Rich Text Editor component to your Razor page:

@using Syncfusion.Blazor.RichTextEditor

<SfRichTextEditor></SfRichTextEditor>

3. Configure the toolbar with specific tools

@using Syncfusion.Blazor.RichTextEditor

<SfRichTextEditor @bind-Value="@content">
    <RichTextEditorToolbarSettings Items="@tools" />
</SfRichTextEditor>

@code {
    private string content = "<p>Start typing...</p>";
    
    private List<ToolbarItemModel> tools = new List<ToolbarItemModel>()
    {
        new ToolbarItemModel() { Command = ToolbarCommand.Bold },
        new ToolbarItemModel() { Command = ToolbarCommand.Italic },
        new ToolbarItemModel() { Command = ToolbarCommand.Underline },
        new ToolbarItemModel() { Command = ToolbarCommand.Separator },
        new ToolbarItemModel() { Command = ToolbarCommand.Formats },
        new ToolbarItemModel() { Command = ToolbarCommand.Alignments },
        new ToolbarItemModel() { Command = ToolbarCommand.OrderedList },
        new ToolbarItemModel() { Command = ToolbarCommand.UnorderedList },
        new ToolbarItemModel() { Command = ToolbarCommand.Separator },
        new ToolbarItemModel() { Command = ToolbarCommand.CreateLink },
        new ToolbarItemModel() { Command = ToolbarCommand.Image },
        new ToolbarItemModel() { Command = ToolbarCommand.Separator },
        new ToolbarItemModel() { Command = ToolbarCommand.Undo },
        new ToolbarItemModel() { Command = ToolbarCommand.Redo }
    };
}

4. Enable Markdown editing

@using Syncfusion.Blazor.RichTextEditor

<SfRichTextEditor EditorMode="EditorMode.Markdown" @bind-Value="@markdownContent">
    <RichTextEditorToolbarSettings Items="@markdownTools" />
</SfRichTextEditor>

@code {
    private string markdownContent = "# Hello Markdown\n\nThis is **bold** and this is *italic*.";
    
    private List<ToolbarItemModel> markdownTools = new List<ToolbarItemModel>()
    {
        new ToolbarItemModel() { Command = ToolbarCommand.Bold },
        new ToolbarItemModel() { Command = ToolbarCommand.Italic },
        new ToolbarItemModel() { Command = ToolbarCommand.StrikeThrough },
        new ToolbarItemModel() { Command = ToolbarCommand.Separator },
        new ToolbarItemModel() { Command = ToolbarCommand.Formats },
        new ToolbarItemModel() { Command = ToolbarCommand.OrderedList },
        new ToolbarItemModel() { Command = ToolbarCommand.UnorderedList },
        new ToolbarItemModel() { Command = ToolbarCommand.Separator },
        new ToolbarItemModel() { Command = ToolbarCommand.CreateLink },
        new ToolbarItemModel() { Command = ToolbarCommand.Image }
    };
}

Documentation

• Getting Started with Blazor Web App
• Getting Started with Blazor WebAssembly
• API Reference
• Blazor Rich Text Editor Component Features Overview
• Blazor Rich Text Editor Component Demos
• Blazor Rich Text Editor Component Video Tutorials

Support and Feedback

• For queries, reach our Syncfusion support team or post them through the community forums.
• Request new features through the Syncfusion feedback portal.

Other Popular Blazor Components

Explore other popular Syncfusion Blazor components curated from UI components, standalone SDKs, and document solution suites.

License

This is a commercial product and requires a paid license for possession or use. Syncfusion licensed software, including this component, is subject to the terms and conditions of the Syncfusion EULA. You can purchase a license here or start a free 30-day trial here.

About Syncfusion

Founded in 2001 and headquartered in Research Triangle Park, N.C., Syncfusion has more than 29,000 customers and more than 1 million users, including large financial institutions, Fortune 500 companies, and global IT consultancies.

Today, we provide 1800+ components and frameworks for web, mobile, and desktop development across multiple platforms:

Web: Blazor | ASP.NET Core | ASP.NET MVC | JavaScript | Angular | React | Vue

Mobile: Flutter | MAUI | UWP

Desktop: WinForms | WPF | WinUI

Learn more at www.syncfusion.com.

sales@syncfusion.com | Toll Free: 1-888-9-DOTNET