Skip to content

getting-started-webapp.md

Latest commit

 

History

History
243 lines (145 loc) · 10.8 KB

getting-started-webapp.md

File metadata and controls

243 lines (145 loc) · 10.8 KB
layout post
title Getting started with Markdown Editor in Blazor Web App | Syncfusion®
description Check out the documentation for getting started with Blazor Markdown Editor Components in Blazor Web App.
platform Blazor
control MarkdownEditor
documentation ug

Getting Started with Blazor Markdown Editor in Blazor Web App

This section explains how to integrate Blazor Markdown Editor component in your 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 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 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, 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) or command shell (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 %}

{% 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 required Blazor packages

Install the following NuGet packages in your project:

You can install these packages using different methods as shown below:

{% tabcontents %}

{% tabcontent Visual Studio %}

  1. In Visual Studio Navigate to:

    Tools → NuGet Package Manager → Manage NuGet Packages for Solution

  2. Search for the required packages.

  3. Select the package and click Install.

{% endtabcontent %}

{% tabcontent Visual Studio (Package Manager Console) %}

  1. In Visual Studio Navigate to:

    Tools → NuGet Package Manager → Package Manager Console

  2. Run the following commands:

{% tabs %} {% highlight C# tabtitle="Install Packages" %}

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

{% endhighlight %} {% endtabs %}

{% endtabcontent %}

{% tabcontent Visual Studio Code / .NET CLI %}

  1. Open your project.
  2. Open the terminal:
    • In Visual Studio Code: use the integrated terminal (Ctrl + `)
    • Or use any system terminal for CLI
  3. Run the following commands:

{% tabs %} {% highlight C# tabtitle="Install Packages" %}

dotnet add package Syncfusion.Blazor.RichTextEditor --version {{ site.releaseversion }} dotnet add package Syncfusion.Blazor.Themes --version {{ site.releaseversion }}

{% endhighlight %} {% endtabs %}

{% endtabcontent %}

{% endtabcontents %}

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

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

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

{% endhighlight %} {% endtabs %}

Register 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 %}

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

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 your Blazor application. Also, check out the Adding Script Reference topic to learn different approaches for adding script references in your Blazor application.

Add Blazor Markdown Editor component

Add the Syncfusion Blazor Markdown 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 tabtitle="Home.razor" %}

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

@using Syncfusion.Blazor.RichTextEditor

@code { private string MarkdownValue { get; set; } = @"Rich Text Editor formats text instantly using toolbar actions, whereas Markdown uses syntax to apply formatting. Markdown editing is supported when editorMode is set to markdown, allowing formatting via toolbar or keyboard. Custom Markdown syntax can also be added. This sample uses the Marked library to convert Markdown to HTML. Sample link.";

}

{% endhighlight %} {% endtabs %}

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 Blazor Markdown Editor component in the default web browser.

N> When using the .NET CLI or Visual Studio Code, ensure that you run the application from the server (host) project directory, not from the .Client project. The client project does not run independently and is hosted by the server application.

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

See also