Skip to content

[DataGrid] Asynchronous IQueryable based loading enhancements #4343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vnbaaij merged 2 commits into from
Nov 22, 2025
Merged

[DataGrid] Asynchronous IQueryable based loading enhancements #4343

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b92e7a5
Fixed async 'Loading' state flag feedback and Virtual mode switch ren…
miguelhasse Nov 22, 2025
f97a0c3
Merge branch 'dev' into grid-async-loading-enhancements
miguelhasse Nov 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 30 additions & 16 deletions src/Core/Components/DataGrid/FluentDataGrid.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,7 @@ public partial class FluentDataGrid<TGridItem> : FluentComponentBase, IHandleEve
// async query APIs that might be available. We have built-in support for using EF Core's async query APIs.
private IAsyncQueryExecutor? _asyncQueryExecutor;
private AsyncServiceScope? _scope;
private bool _asyncQueryExecuted;

// We cascade the InternalGridContext to descendants, which in turn call it to add themselves to _columns
// This happens on every render so that the column list can be updated dynamically
Expand Down Expand Up @@ -411,6 +412,7 @@ public partial class FluentDataGrid<TGridItem> : FluentComponentBase, IHandleEve
// things have changed, and to discard earlier load attempts that were superseded.
private PaginationState? _lastRefreshedPaginationState;
private IQueryable<TGridItem>? _lastAssignedItems;
private bool? _lastVirtualizationMode;

private GridItemsProvider<TGridItem>? _lastAssignedItemsProvider;
private CancellationTokenSource? _pendingDataLoadCancellationTokenSource;
Expand Down Expand Up @@ -483,12 +485,23 @@ protected override Task OnParametersSetAsync()
_lastAssignedItemsProvider = ItemsProvider;
_lastAssignedItems = Items;
_asyncQueryExecutor = AsyncQueryExecutorSupplier.GetAsyncQueryExecutor(_scope.Value.ServiceProvider, Items);
_asyncQueryExecuted = false;
}

var paginationStateHasChanged =
Pagination?.ItemsPerPage != _lastRefreshedPaginationState?.ItemsPerPage
|| Pagination?.CurrentPageIndex != _lastRefreshedPaginationState?.CurrentPageIndex;

if (_lastVirtualizationMode != Virtualize)
{
_lastVirtualizationMode = Virtualize;
_asyncQueryExecuted = false;
}
if (Loading == true && _asyncQueryExecutor is not null && _asyncQueryExecuted)
{
Loading = false; // switch to uncontrolled loading state after first IAsyncQueryExecutor completes
}

var mustRefreshData = dataSourceHasChanged || paginationStateHasChanged || EffectiveLoadingValue;

// We don't want to trigger the first data load until we've collected the initial set of columns,
Expand Down Expand Up @@ -865,7 +878,7 @@ private async Task RefreshDataCoreAsync()
{
Pagination?.SetTotalItemCountAsync(_internalGridContext.TotalItemCount);
}
if ((_internalGridContext.TotalItemCount > 0 && Loading is null) || _lastError != null)
if ((_internalGridContext.TotalItemCount > 0 && Loading != false) || _lastError != null)
{
Loading = false;
StateHasChanged();
Expand Down Expand Up @@ -904,13 +917,7 @@ private async ValueTask<GridItemsProviderResult<TGridItem>> ResolveItemsRequestA
}
else if (Items is not null)
{
if (_asyncQueryExecutor is not null)
{
await OnItemsLoading.InvokeAsync(true);
}
var totalItemCount = _asyncQueryExecutor is null ? Items.Count() : await _asyncQueryExecutor.CountAsync(Items, request.CancellationToken);
_internalGridContext.TotalItemCount = totalItemCount;
IQueryable<TGridItem>? result;
var result = Items;
if (RefreshItems is null)
{
result = request.ApplySorting(Items).Skip(request.StartIndex);
Expand All @@ -919,12 +926,24 @@ private async ValueTask<GridItemsProviderResult<TGridItem>> ResolveItemsRequestA
result = result.Take(request.Count.Value);
}
}
if (_asyncQueryExecutor is not null)
{
await OnItemsLoading.InvokeAsync(true);
var totalItemCount = await _asyncQueryExecutor.CountAsync(Items, request.CancellationToken);
var resultArray = await _asyncQueryExecutor.ToArrayAsync(result, request.CancellationToken);

Loading = false;
_asyncQueryExecuted = true;
_internalGridContext.TotalItemCount = totalItemCount;

return GridItemsProviderResult.From(resultArray, totalItemCount);
}
else
{
result = Items;
var totalItemCount = Items.Count();
_internalGridContext.TotalItemCount = totalItemCount;
return GridItemsProviderResult.From([.. result], totalItemCount);
}
var resultArray = _asyncQueryExecutor is null ? [.. result] : await _asyncQueryExecutor.ToArrayAsync(result, request.CancellationToken);
return GridItemsProviderResult.From(resultArray, totalItemCount);
}
}
catch (OperationCanceledException oce) when (oce.CancellationToken == request.CancellationToken)
Expand All @@ -939,11 +958,6 @@ private async ValueTask<GridItemsProviderResult<TGridItem>> ResolveItemsRequestA
{
if (Items is not null && _asyncQueryExecutor is not null)
{
if (Loading == true)
{
Loading = false;
StateHasChanged();
}
await OnItemsLoading.InvokeAsync(false);
}
}
Expand Down
Loading