Skip to content

getting-started-with-web-app.md

Latest commit

 

History

History
334 lines (226 loc) · 15.8 KB

getting-started-with-web-app.md

File metadata and controls

334 lines (226 loc) · 15.8 KB
Raw
layout post
title Getting Started with Blazor DataManager in Web App | Syncfusion®
description Checkout and learn about the documentation for getting started with Blazor DataManager Component in Blazor Web App.
platform Blazor
component DataManager
documentation ug

Getting Started with Blazor DataManager Component in Blazor Web App

This section briefly explains about how to include Blazor DataManager 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, 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) 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 %}

This command creates a new Blazor Web App and places it in a new directory called BlazorWebApp inside your 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 Blazor packages

Install Syncfusion.Blazor.Data 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.Data -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.Data namespaces.

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

@using Syncfusion.Blazor @using Syncfusion.Blazor.Data

{% endhighlight %} {% endtabs %}

Register Blazor service

Register the 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 DataManager component

Add the Blazor DataManager 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 %}

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

{% endhighlight %} {% endtabs %}

The SfDataManager component acts as a data gateway for Blazor components that support data binding. It enables interaction with local or remote data sources using queries.

Binding to JSON data

Local JSON data can be bound to the DataGrid component by assigning a collection of objects to the Json property of the SfDataManager component.

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

@using Syncfusion.Blazor.Grids @using Syncfusion.Blazor.Data

@code {

public List<EmployeeData> Employees { get; set; } = new()
{
    new EmployeeData { EmployeeID = 1, Name = "Nancy Fuller", Title = "Vice President" },
    new EmployeeData { EmployeeID = 2, Name = "Steven Buchanan", Title = "Sales Manager" },
    new EmployeeData { EmployeeID = 3, Name = "Janet Leverling", Title = "Sales Representative" },
    new EmployeeData { EmployeeID = 4, Name = "Andrew Davolio", Title = "Inside Sales Coordinator" },
    new EmployeeData { EmployeeID = 5, Name = "Steven Peacock", Title = "Inside Sales Coordinator" },
    new EmployeeData { EmployeeID = 6, Name = "Janet Buchanan", Title = "Sales Representative" },
    new EmployeeData { EmployeeID = 7, Name = "Andrew Fuller", Title = "Inside Sales Coordinator" },
    new EmployeeData { EmployeeID = 8, Name = "Steven Davolio", Title = "Inside Sales Coordinator" },
    new EmployeeData { EmployeeID = 9, Name = "Janet Davolio", Title = "Sales Representative" },
    new EmployeeData { EmployeeID = 10, Name = "Andrew Buchanan", Title = "Sales Representative" }
};

public class EmployeeData
{
    public int EmployeeID { get; set; }
    public string? Name { get; set; }
    public string? Title { get; set; }
}

} {% endhighlight %} {% endtabs %}

Binding to OData

Remote data can be bound by setting the Url property and specifying the appropriate adaptor using the Adaptor property of the SfDataManager component.

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

@using Syncfusion.Blazor @using Syncfusion.Blazor.Data @using Syncfusion.Blazor.Grids

@code {

public class Order
{
    public int? OrderID { get; set; }
    public string? CustomerID { get; set; }
    public DateTime? OrderDate { get; set; }
    public double? Freight { get; set; }
}

}

{% endhighlight %} {% endtabs %}

Component binding

The Blazor DataManager component can be integrated with any data-bound component to manage local or remote data operations.

This configuration demonstrates how the DataManager is bound to the SfDropDownList component to enable consistent interaction with local or remote data sources.

Local data binding

Local data can be bound to components such as SfDropDownList by assigning a collection of objects to the Json property of the SfDataManager component.

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

@using Syncfusion.Blazor.Data @using Syncfusion.Blazor.DropDowns

@code { public class Country { public string? Name { get; set; } public string? Code { get; set; } }

public List<Country> Countries = new()
{
    new Country { Name = "Australia", Code = "AU" },
    new Country { Name = "Bermuda", Code = "BM" },
    new Country { Name = "Canada", Code = "CA" },
    new Country { Name = "Cameroon", Code = "CM" }
};

}

{% endhighlight %} {% endtabs %}

{% previewsample "https://blazorplayground.syncfusion.com/embed/VthdDHVATdWQWVJr?appbar=false&editor=false&result=true&errorlist=false&theme=fluent2" backgroundimage "Binding DropDownList Item in Blazor DataManager Component" %}

Remote data binding

Remote data can be bound by setting the Url property and specifying the appropriate adaptor using the Adaptor property of the SfDataManager component.

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

@using Syncfusion.Blazor @using Syncfusion.Blazor.Data @using Syncfusion.Blazor.DropDowns

@code {

public class Contact
{
    public string? ContactName { get; set; }
    public string? CustomerID { get; set; }
}

}

{% endhighlight %} {% endtabs %}

{% previewsample "https://blazorplayground.syncfusion.com/embed/BDLxNRLKJdVyyhZu?appbar=false&editor=false&result=true&errorlist=false&theme=fluent2" backgroundimage "Data Binding in Blazor DataManager Component" %}

N> View the complete sample on GitHub..

See also

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