Skip to content

Latest commit

 

History

History
156 lines (111 loc) · 9.9 KB

quickgrid.md

File metadata and controls

156 lines (111 loc) · 9.9 KB
Raw
title author description monikerRange ms.author ms.custom ms.date uid
ASP.NET Core Blazor QuickGrid component
guardrex
The QuickGrid component is a Razor component for quickly and efficiently displaying data in tabular form.
>= aspnetcore-7.0
riande
mvc
11/14/2023
blazor/components/quickgrid

ASP.NET Core Blazor QuickGrid component

[!INCLUDE]

:::moniker range=">= aspnetcore-8.0"

The QuickGrid component is a Razor component for quickly and efficiently displaying data in tabular form. QuickGrid provides a simple and convenient data grid component for common grid rendering scenarios and serves as a reference architecture and performance baseline for building data grid components. QuickGrid is highly optimized and uses advanced techniques to achieve optimal rendering performance.

[!INCLUDE]

Package

Add a package reference for the Microsoft.AspNetCore.Components.QuickGrid package.

[!INCLUDE]

Sample app

For various QuickGrid demonstrations, see the QuickGrid for Blazor sample app. The demo site is hosted on GitHub Pages. The site loads fast thanks to static prerendering using the community-maintained BlazorWasmPrerendering.Build GitHub project.

QuickGrid implementation

To implement a QuickGrid component:

  • Specify tags for the QuickGrid component in Razor markup (<QuickGrid>...</QuickGrid>).
  • Name a queryable source of data for the grid. Use either of the following data sources:
    • Items: A nullable IQueryable<TGridItem>, where TGridItem is the type of data represented by each row in the grid.
    • ItemsProvider: A callback that supplies data for the grid.
  • Class: An optional CSS class name. If provided, the class name is included in the class attribute of the rendered table.
  • Theme: A theme name (default value: default). This affects which styling rules match the table.
  • Virtualize: If true, the grid is rendered with virtualization. This is normally used in conjunction with scrolling and causes the grid to fetch and render only the data around the current scroll viewport. This can greatly improve the performance when scrolling through large data sets. If you use Virtualize, you should supply a value for ItemSize and must ensure that every row renders with a constant height. Generally, it's preferable not to use Virtualize if the amount of data rendered is small or if you're using pagination.
  • ItemSize: Only applicable when using Virtualize. ItemSize defines an expected height in pixels for each row, allowing the virtualization mechanism to fetch the correct number of items to match the display size and to ensure accurate scrolling.
  • ItemKey: Optionally defines a value for @key on each rendered row. Typically, this is used to specify a unique identifier, such as a primary key value, for each data item. This allows the grid to preserve the association between row elements and data items based on their unique identifiers, even when the TGridItem instances are replaced by new copies (for example, after a new query against the underlying data store). If not set, the @key is the TGridItem instance.
  • Pagination: Optionally links this TGridItem instance with a PaginationState model, causing the grid to fetch and render only the current page of data. This is normally used in conjunction with a Paginator component or some other UI logic that displays and updates the supplied PaginationState instance.
  • In the QuickGrid child content (xref:Microsoft.AspNetCore.Components.RenderFragment), specify PropertyColumns, which represent TGridItem columns whose cells display values:
    • Property: Defines the value to be displayed in this column's cells.
    • Format: Optionally specifies a format string for the value. Using Format requires the TProp type to implement IFormattable.
    • Sortable: Indicates whether the data should be sortable by this column. The default value may vary according to the column type. For example, a TemplateColumn<TGridItem> is sortable by default if any TemplateColumn<TGridItem>.SortBy parameter is specified.
    • InitialSortDirection: Indicates the sort direction if IsDefaultSortColumn is true.
    • IsDefaultSortColumn: Indicates whether this column should be sorted by default.
    • PlaceholderTemplate: If specified, virtualized grids use this template to render cells whose data hasn't been loaded.

For example, add the following component to render a grid.

The component assumes that the Interactive Server render mode (InteractiveServer) is inherited from a parent component or applied globally to the app, which enables interactive features. For the following example, the only interactive feature is sortable columns.

QuickGridExample.razor:

@page "/quickgrid-example"
@using Microsoft.AspNetCore.Components.QuickGrid

<QuickGrid Items="@people">
    <PropertyColumn Property="@(p => p.PersonId)" Sortable="true" />
    <PropertyColumn Property="@(p => p.Name)" Sortable="true" />
    <PropertyColumn Property="@(p => p.PromotionDate)" Format="yyyy-MM-dd" Sortable="true" />
</QuickGrid>

@code {
    private record Person(int PersonId, string Name, DateOnly PromotionDate);

    private IQueryable<Person> people = new[]
    {
        new Person(10895, "Jean Martin", new DateOnly(1985, 3, 16)),
        new Person(10944, "António Langa", new DateOnly(1991, 12, 1)),
        new Person(11203, "Julie Smith", new DateOnly(1958, 10, 10)),
        new Person(11205, "Nur Sari", new DateOnly(1922, 4, 27)),
        new Person(11898, "Jose Hernandez", new DateOnly(2011, 5, 3)),
        new Person(12130, "Kenji Sato", new DateOnly(2004, 1, 9)),
    }.AsQueryable();
}

For an example that uses an xref:System.Linq.IQueryable with Entity Framework Core as the queryable data source, see the SampleQuickGridComponent component in the ASP.NET Core Basic Test App (dotnet/aspnetcore GitHub repository).

[!INCLUDE]

To use Entity Framework (EF) Core as the data source:

  • Add a prerelease package reference for the Microsoft.AspNetCore.Components.QuickGrid.EntityFrameworkAdapter package. If using the .NET CLI to add the package reference, include the --prerelease option when you execute the dotnet add package command.

    [!INCLUDE]

  • Call AddQuickGridEntityFrameworkAdapter on the service collection in the Program file to register an EF-aware implementation of IAsyncQueryExecutor:

    builder.Services.AddQuickGridEntityFrameworkAdapter();

QuickGrid supports passing custom attributes to the rendered table element:

<QuickGrid Items="..." custom-attribute="somevalue" class="custom-class">

:::moniker-end

:::moniker range="< aspnetcore-8.0"

The QuickGrid component is an experimental Razor component for quickly and efficiently displaying data in tabular form. QuickGrid provides a simple and convenient data grid component for common grid rendering scenarios and serves as a reference architecture and performance baseline for building data grid components. QuickGrid is highly optimized and uses advanced techniques to achieve optimal rendering performance.

To get started with QuickGrid:

Add a prerelease package reference for the Microsoft.AspNetCore.Components.QuickGrid package. If using the .NET CLI to add the package reference, include the --prerelease option when you execute the dotnet add package command.

[!INCLUDE]

Note

Because the Microsoft.AspNetCore.Components.QuickGrid package is an experimental package for .NET 7, the package remains in prerelease status forever for .NET 7 Blazor apps. The package reached production status for .NET 8 or later. For more information, see an 8.0 or later version of this article.

Add the following component to render a grid.

QuickGridExample.razor:

@page "/quickgrid-example"
@using Microsoft.AspNetCore.Components.QuickGrid

<QuickGrid Items="@people">
    <PropertyColumn Property="@(p => p.PersonId)" Sortable="true" />
    <PropertyColumn Property="@(p => p.Name)" Sortable="true" />
    <PropertyColumn Property="@(p => p.PromotionDate)" Format="yyyy-MM-dd" Sortable="true" />
</QuickGrid>

@code {
    private record Person(int PersonId, string Name, DateOnly PromotionDate);

    private IQueryable<Person> people = new[]
    {
        new Person(10895, "Jean Martin", new DateOnly(1985, 3, 16)),
        new Person(10944, "António Langa", new DateOnly(1991, 12, 1)),
        new Person(11203, "Julie Smith", new DateOnly(1958, 10, 10)),
        new Person(11205, "Nur Sari", new DateOnly(1922, 4, 27)),
        new Person(11898, "Jose Hernandez", new DateOnly(2011, 5, 3)),
        new Person(12130, "Kenji Sato", new DateOnly(2004, 1, 9)),
    }.AsQueryable();
}

:::moniker-end

Access the component in a browser at the relative path /quickgrid-example.

There aren't current plans to extend QuickGrid with features that full-blown commercial grids tend to offer, for example, hierarchical rows, drag-to-reorder columns, or Excel-like range selections. If you require advanced features that you don't wish to develop on your own, continue using third-party grids.