Skip to content

getting-started.md

Latest commit

 

History

History
309 lines (210 loc) · 14.3 KB

getting-started.md

File metadata and controls

309 lines (210 loc) · 14.3 KB
Raw
layout post
title Getting Started with Blazor DataManager Component | Syncfusion®
description Learn how to configure and use the Syncfusion Blazor DataManager component in a Blazor WebAssembly application.
platform Blazor
control DataManager
documentation ug

Getting Started with Blazor DataManager Component

The Blazor DataManager component provides a robust data access layer for Blazor applications. It enables seamless interaction with both local and remote data sources and supports essential operations such as querying, sorting, filtering, and CRUD actions. The component is designed to work in conjunction with data-bound controls, ensuring efficient data management across the application.

This guide explains how to configure and use the DataManager component in a Blazor WebAssembly application using Visual Studio, Visual Studio Code, and the .NET CLI.

{% tabcontents %}

{% tabcontent Visual Studio %}

Prerequisites

Create a new Blazor App in Visual Studio

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

{% endtabcontent %}

{% tabcontent Visual Studio Code %}

Prerequisites

Create a new Blazor App in Visual Studio Code

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

Alternatively, create a WebAssembly application by using the following command in the integrated terminal (Ctrl+`).

{% tabs %}

{% highlight c# tabtitle="Blazor WASM App" %}

dotnet new blazorwasm -o BlazorApp cd BlazorApp

{% endhighlight %}

{% endtabs %}

{% endtabcontent %}

{% tabcontent .NET CLI %}

Prerequisites

Install the latest version of .NET SDK. If the .NET SDK is already installed, determine the installed version by running the following command in a command prompt (Windows), terminal (macOS), or command shell (Linux).

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

dotnet --version

{% endhighlight %} {% endtabs %}

Create a Blazor WebAssembly App using .NET CLI

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

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

dotnet new blazorwasm -o BlazorApp cd BlazorApp

{% endhighlight %} {% endtabs %}

{% endtabcontent %}

{% endtabcontents %}

Install required 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 %}

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 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 WebAssembly 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 ~/index.html 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 Blazor DataManager component

Add the Blazor DataManager component in the ~/Pages/Index.razor file.

The SfDataManager component is designed to work with data-bound components that support data operations. It serves as a gateway for both local and remote data, enabling interaction with the data source based on the configured query.

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="Index.razor" %}

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

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

public List<EmployeeData> Employees = 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 Coordinato" },
    new EmployeeData { EmployeeID = 9, Name = "Janet Davolio", Title = "Sales Representative" },
    new EmployeeData { EmployeeID = 10, Name = "Andrew Buchanan", Title = "Sales Representative" }
};

}

{% endhighlight %} {% endtabs %}

Binding to OData

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

{% tabs %} {% highlight razor tabtitle="Index.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="Index.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="Index.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 Sample on GitHub.