Skip to content

Commit 0df1def

Browse files
Provide Microsoft.AspNetCore.Components.QuickGrid package (dotnet#57793)
1 parent 6832df1 commit 0df1def

File tree

1 file changed

+45
-0
lines changed
  • src/Components/QuickGrid/Microsoft.AspNetCore.Components.QuickGrid/src

1 file changed

+45
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## About
2+
3+
`Microsoft.AspNetCore.Components.QuickGrid` provides a simple and convenient data grid component for common grid rendering scenarios.
4+
5+
## Key Features
6+
7+
* Pagination
8+
* Filtering
9+
* Sorting
10+
* Virtualization
11+
* Support for in-memory `IQueryable`, EF Core `IQueryable`, and remote data sources
12+
* Configurable column properties
13+
* Customizable styling
14+
15+
## How to Use
16+
17+
To use `Microsoft.AspNetCore.Components.QuickGrid`, follow these steps:
18+
19+
### Installation
20+
21+
```shell
22+
dotnet add package Microsoft.AspNetCore.Components.QuickGrid
23+
```
24+
25+
### Usage
26+
27+
For various `QuickGrid` demonstrations, see the [QuickGrid for Blazor sample app](https://aspnet.github.io/quickgridsamples).
28+
29+
## Main Types
30+
31+
* `QuickGrid<TGridItem>`: The component that displays the grid
32+
* `TemplateColumn`: Represents a column whose cells render a supplied template
33+
* `PropertyColumn`: Represents a column whose cells display a single value
34+
* `Paginator`: A component that provides a user interface for `PaginationState`
35+
* `PaginationState`: Holds state to represent pagination in a `QuickGrid<TGridItem>`
36+
* `GridSort<TGridItem>`: Represents a sort order specification used within `QuickGrid<TGridItem>`
37+
* `GridItemsProvider<TGridItem>`: A callback that provides data for a `QuickGrid<TGridItem>`
38+
39+
## Additional Documentation
40+
41+
For additional documentation and examples, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/blazor/components/quickgrid) on the Blazor `QuickGrid` component.
42+
43+
## Feedback &amp; Contributing
44+
45+
`Microsoft.AspNetCore.Components.QuickGrid` is released as open-source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/aspnetcore).

0 commit comments

Comments
 (0)