Skip to content

getting-started.md

Latest commit

 

History

History
237 lines (156 loc) · 11.8 KB

getting-started.md

File metadata and controls

237 lines (156 loc) · 11.8 KB
layout post
title Getting Started with Syncfusion Blazor Block Editor
description Learn how to get started with the Blazor Block Editor component in Blazor Web App using Visual Studio, Visual Studio Code, or the .NET CLI.
platform Blazor
control BlockEditor
documentation ug

Getting Started with Blazor Block Editor in Blazor Web App

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.

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

{% tabcontents %}

{% tabcontent Visual Studio %}

Prerequisites

Create a new Blazor Web App in Visual Studio

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

{% endtabcontent %}

{% tabcontent Visual Studio Code %}

Prerequisites

Create a new Blazor Web App in Visual Studio Code

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

For example, in a Blazor Web App with the Auto interactive render mode, use the following commands in the integrated terminal (Ctrl+`).

{% tabs %} {% highlight c# tabtitle="Blazor Web App" %}

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

{% endhighlight %} {% endtabs %}

{% endtabcontent %}

{% tabcontent .NET CLI %}

Prerequisites

Install the latest version of .NET SDK. If you previously installed the SDK, you can determine the installed version by executing the following command in a command prompt (Windows) or terminal (macOS) or command shell (Linux).

{% tabs %} {% highlight c# tabtitle=".NET CLI" %}

dotnet --version

{% endhighlight %} {% endtabs %}

Create a Blazor Web App using .NET CLI

Run the following command to create a new Blazor Web App in a command prompt (Windows) or terminal (macOS/Linux). For detailed instructions, refer to the Blazor Web App Getting Started documentation.

For example, in a Blazor Web App with the Auto interactive render mode, use the following commands:

{% tabs %} {% highlight c# tabtitle="Blazor Web App" %}

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

{% endhighlight %} {% endtabs %}

This command creates a new Blazor Web App and places it in a new directory called BlazorWebApp inside the current location. See the Create a Blazor App and dotnet new CLI command topics for more details.

{% endtabcontent %}

{% endtabcontents %}

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

{% tabs %} {% highlight C# tabtitle="Package Manager" %}

Install-Package Syncfusion.Blazor.BlockEditor -Version {{ site.releaseversion }} Install-Package Syncfusion.Blazor.Themes -Version {{ site.releaseversion }}

{% endhighlight %} {% endtabs %}

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

N> 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.BlockEditor namespaces.

{% tabs %} {% highlight C# tabtitle="~/_Imports.razor" %}

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

{% endhighlight %} {% endtabs %}

Register Syncfusion® Blazor service

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

{% tabs %} {% highlight c# tabtitle="Program.cs" %}

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

{% endhighlight %} {% endtabs %}

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>

N> 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 ~/Components/Pages/*.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 ~Pages/*.razor file. (For example, InteractiveServer, InteractiveWebAssembly or InteractiveAuto).

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

{% tabs %} {% highlight razor %}

@* Define desired render mode here *@ @rendermode InteractiveAuto

{% endhighlight %} {% endtabs %}

{% tabs %} {% highlight razor tabtitle="Home.razor" %}

{% endhighlight %} {% endtabs %}

  • Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This renders the Syncfusion® Blazor Block Editor component in the default web browser.

{% previewsample "https://blazorplayground.syncfusion.com/embed/LNLIsrhAgbKCOpbZ?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor BlockEditor Default." %}

Configure blocks

The Block Editor uses a block-based content structure where each block represents a specific content type (heading, paragraph, list, etc.). The Blocks property manages and configures these blocks, allowing full control over the content structure and presentation.

{% tabs %} {% highlight razor tabtitle="Home.razor" %}

@using Syncfusion.Blazor.BlockEditor

<SfBlockEditor @bind-Blocks="blockDataOverview">

@code { private List 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;
    }
}

}

{% endhighlight %} {% endtabs %}

{% previewsample "https://blazorplayground.syncfusion.com/embed/rNBSiBVATWtpaEWo?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor Block Editor Component" %}

N> View Sample in GitHub