Syncfusion AI Assistant

How can I help you?

Getting Started with Blazor Image Editor Component in Blazor Web App

29 May 20266 minutes to read

This section briefly explains about how to include the Syncfusion® Blazor Image Editor component in your Blazor Web App using Visual Studio, Visual Studio Code, and the .NET CLI.

To get started quickly with the Blazor Image Editor component, refer to this video or the GitHub sample:

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.

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+`):

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

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/Linux).

dotnet --version

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:

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

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 Syncfusion® Blazor packages

Install the Syncfusion.Blazor.ImageEditor and Syncfusion.Blazor.Themes NuGet packages using one of the following methods.

Visual Studio (NuGet Package Manager):

  1. Go to Tools → NuGet Package Manager → Manage NuGet Packages for Solution.
  2. Search the required NuGet packages (Syncfusion.Blazor.ImageEditor and Syncfusion.Blazor.Themes) and install it.

Visual Studio Code or .NET CLI:

Open the terminal or command prompt and run the following commands:

dotnet add package Syncfusion.Blazor.ImageEditor -v 33.2.3
dotnet add package Syncfusion.Blazor.Themes -v 33.2.3

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

NOTE

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

@using Syncfusion.Blazor
@using Syncfusion.Blazor.ImageEditor

Register Syncfusion® Blazor service

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

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

NOTE

If the Interactive Render Mode is set to WebAssembly or Auto, register the Syncfusion® 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>

NOTE

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 Syncfusion® Blazor Image Editor component

  • Open a Razor file located in the ~/Components/Pages (for example, Home.razor) and add the Blazor Image Editor component inside the 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 razor file. (For example, InteractiveServer, InteractiveWebAssembly or InteractiveAuto).

NOTE

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.

@rendermode InteractiveAuto
@using Syncfusion.Blazor.ImageEditor

<SfImageEditor Height="500"></SfImageEditor>

Run the application

Visual Studio:

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

Visual Studio Code or .NET CLI:

  1. Open the terminal (Visual Studio Code) or command prompt (.NET CLI) and navigate to the Client project folder.

  2. Run the following command:

     dotnet run
  3. The application will start and display in your default web browser.
Blazor Image Editor Component

NOTE

View Sample in GitHub.

See also

  1. Getting Started with Syncfusion® Blazor Web Assembly App in Visual Studio or .NET CLI
  2. Getting Started with Syncfusion® Blazor Web App in Visual Studio or .NET CLI