File: Pagination\PaginationState.cs
Web Access
Project: src\src\Components\QuickGrid\Microsoft.AspNetCore.Components.QuickGrid\src\Microsoft.AspNetCore.Components.QuickGrid.csproj (Microsoft.AspNetCore.Components.QuickGrid)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using Microsoft.AspNetCore.Components.QuickGrid.Infrastructure;
 
namespace Microsoft.AspNetCore.Components.QuickGrid;
 
/// <summary>
/// Holds state to represent pagination in a <see cref="QuickGrid{TGridItem}"/>.
/// </summary>
public class PaginationState
{
    /// <summary>
    /// Gets or sets the number of items on each page.
    /// </summary>
    public int ItemsPerPage { get; set; } = 10;
 
    /// <summary>
    /// Gets the current zero-based page index. To set it, call <see cref="SetCurrentPageIndexAsync(int)" />.
    /// </summary>
    public int CurrentPageIndex { get; private set; }
 
    /// <summary>
    /// Gets the total number of items across all pages, if known. The value will be null until an
    /// associated <see cref="QuickGrid{TGridItem}"/> assigns a value after loading data.
    /// </summary>
    public int? TotalItemCount { get; private set; }
 
    /// <summary>
    /// Gets the zero-based index of the last page, if known. The value will be null until <see cref="TotalItemCount"/> is known.
    /// </summary>
    public int? LastPageIndex => (TotalItemCount - 1) / ItemsPerPage;
 
    /// <summary>
    /// An event that is raised when the total item count has changed.
    /// </summary>
    public event EventHandler<int?>? TotalItemCountChanged;
 
    internal EventCallbackSubscribable<PaginationState> CurrentPageItemsChanged { get; } = new();
    internal EventCallbackSubscribable<PaginationState> TotalItemCountChangedSubscribable { get; } = new();
 
    /// <inheritdoc />
    public override int GetHashCode()
        => HashCode.Combine(ItemsPerPage, CurrentPageIndex, TotalItemCount);
 
    /// <summary>
    /// Sets the current page index, and notifies any associated <see cref="QuickGrid{TGridItem}"/>
    /// to fetch and render updated data.
    /// </summary>
    /// <param name="pageIndex">The new, zero-based page index.</param>
    /// <returns>A <see cref="Task"/> representing the completion of the operation.</returns>
    public Task SetCurrentPageIndexAsync(int pageIndex)
    {
        CurrentPageIndex = pageIndex;
        return CurrentPageItemsChanged.InvokeCallbacksAsync(this);
    }
 
    // Can be internal because this only needs to be called by QuickGrid itself, not any custom pagination UI components.
    internal Task SetTotalItemCountAsync(int totalItemCount)
    {
        if (totalItemCount == TotalItemCount)
        {
            return Task.CompletedTask;
        }
 
        TotalItemCount = totalItemCount;
 
        if (CurrentPageIndex > 0 && CurrentPageIndex > LastPageIndex)
        {
            // If the number of items has reduced such that the current page index is no longer valid, move
            // automatically to the final valid page index and trigger a further data load.
            return SetCurrentPageIndexAsync(LastPageIndex.Value);
        }
        else
        {
            // Under normal circumstances, we just want any associated pagination UI to update
            TotalItemCountChanged?.Invoke(this, TotalItemCount);
            return TotalItemCountChangedSubscribable.InvokeCallbacksAsync(this);
        }
    }
}