Skip to content

Commit b57db24

Browse files
Merge pull request #7 from ponselvajeganathan/1055382-virtual
1055382: Update repository README documentation
2 parents cdee730 + 6b9fdcf commit b57db24

1 file changed

Lines changed: 53 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 53 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,61 @@
11
# Blazor Grid Virtualization
22

3-
A quick-start project that helps you how to virtualization in blazor DataGrid.
3+
## Overview
44

5-
**Documentation**: https://blazor.syncfusion.com/documentation/datagrid/virtualization#column-virtualization
5+
This repository contains sample applications that demonstrate virtualization in the Syncfusion [Blazor DataGrid](https://www.syncfusion.com/blazor-components/blazor-datagrid). The samples show how large collections of records can be rendered efficiently by displaying only the rows currently visible within the viewport instead of rendering the entire dataset at once. The repository includes separate implementations for both Blazor Server and Blazor WebAssembly, allowing developers to explore virtualization behavior across different Blazor hosting models. These samples provide a practical reference for implementing high-performance scrolling experiences when working with large amounts of tabular data.
6+
7+
## Key Features
8+
9+
- Demonstrates Syncfusion Blazor DataGrid virtualization.
10+
- Shows how Grid rows are rendered on demand based on the visible viewport.
11+
- Includes examples for both Blazor Server and Blazor WebAssembly applications.
12+
- Provides reference implementations related to DataGrid virtual scrolling.
13+
- Includes scenarios aligned with the Syncfusion DataGrid virtualization documentation.
14+
- References virtual scrolling and virtual mask row examples from the Syncfusion Blazor DataGrid feature set.
15+
- Focuses on improving rendering performance when displaying large datasets.
616

7-
**Online examples**:
8-
* **Virtual scroll**: https://blazor.syncfusion.com/demos/datagrid/virtual-scrolling?theme=fluent
9-
* **Virtual mask row**: https://blazor.syncfusion.com/demos/datagrid/virtual-mask-row?theme=fluent
10-
1117
## Prerequisites
1218

13-
* Visual Studio 2022
19+
- Visual Studio 2022 or Visual Studio Code
20+
- .NET SDK compatible with the project's target framework
21+
22+
## How to Run the Project
23+
24+
**Visual Studio 2022**
25+
26+
1. Clone or download this repository.
27+
2. Open the solution file from either the `Virtualization_Server` or `Virtualization_Wasm` folder.
28+
3. Restore all NuGet packages.
29+
4. Set the selected project as the startup project if required.
30+
5. Build the solution.
31+
6. Run the project using `Ctrl+F5`.
32+
33+
**Visual Studio Code**
34+
35+
1. Open the repository folder in Visual Studio Code.
36+
2. Open the integrated terminal.
37+
3. Navigate to either the `Virtualization_Server` or `Virtualization_Wasm` project directory.
38+
39+
```bash
40+
dotnet restore
41+
dotnet run
42+
```
43+
44+
4. Open the local application URL displayed in the terminal after the application starts.
45+
46+
## Project Structure
47+
48+
- `Virtualization_Server/` — contains the Blazor Server implementation demonstrating Syncfusion Blazor DataGrid virtualization.
49+
- `Virtualization_Wasm/` — contains the Blazor WebAssembly implementation demonstrating Syncfusion Blazor DataGrid virtualization.
50+
- `Virtualization_Server/Pages/` — contains the page that renders the virtualized DataGrid sample.
51+
- `Virtualization_Wasm/Pages/` — contains the page that renders the virtualized DataGrid sample.
52+
53+
## Support and Feedback
54+
55+
- For general product questions, visit the [Syncfusion Community Forum](https://www.syncfusion.com/forums) or [Syncfusion Support](https://www.syncfusion.com/support).
56+
- To report an issue specific to this sample, open a GitHub issue in this repository.
57+
- For official documentation related to this feature, see: https://help.syncfusion.com/grid-sdk/blazor/data-grid/virtual-scrolling
1458

15-
## How to run the project
59+
## License
1660

17-
* Checkout this project to a location in your disk.
18-
* Open the solution file using the Visual Studio 2022.
19-
* Restore the NuGet packages by rebuilding the solution.
20-
* Run the project.
61+
This is a Syncfusion sample project provided to demonstrate product usage. Review the [Syncfusion license terms](https://www.syncfusion.com/sales/pricing?category=ui-components) before using Syncfusion components in your own applications.

0 commit comments

Comments
 (0)