SplatDev.Umbraco.Pagination 2.0.5

SplatDev.Umbraco.Pagination

Core pagination library for the SplatDev Umbraco ecosystem — provides PagedResults<T>, Pagination model, entity interfaces, and extension methods. Zero Umbraco dependency — framework-reference only — making it usable in any .NET project.

Compatibility

This package has no Umbraco dependency and works in any .NET 8+ or .NET 10+ application.

Installation

dotnet add package SplatDev.Umbraco.Pagination

Usage

Basic pagination

using SplatDev.Umbraco.Pagination;
using SplatDev.Umbraco.Pagination.Extensions;

// Create a pagination request
var pagination = new Pagination
{
    Page = 1,
    PageSize = 20
};

// Paginate an IQueryable
var query = dbContext.Products.Where(p => p.IsActive);
var paged = query.PagedResults(pagination);

Console.WriteLine($"Page {paged.Page} of {paged.GetTotalPages()}");
Console.WriteLine($"Showing {paged.Items.Count} of {paged.TotalResults}");

PagedResults<T>

var results = new PagedResults<Product>
{
    Items = products,
    Page = 1,
    PageSize = 20,
    TotalResults = 150
};

// Check navigation state
bool hasNext = results.HasNextPage;
bool hasPrev = results.HasPreviousPage;
int totalPages = results.GetTotalPages();

// Serialize to JSON for APIs
return Ok(results);

Extension methods

using SplatDev.Umbraco.Pagination.Extensions;

// Get total pages
int pages = 150.GetTotalPages(20); // 8

// Paginate any IQueryable
var pagedResults = queryable.PagedResults(page: 1, pageSize: 20);

// Paginate any IEnumerable
var list = new List<string> { "a", "b", "c", "d", "e" };
var paged = list.AsQueryable().PagedResults(1, 3); // ["a","b","c"]

// Shuffle a list
var shuffled = list.Shuffle(); // random order

Entity interfaces

Implement these interfaces to standardize your models:

using SplatDev.Umbraco.Pagination.Interfaces;

public class Product : IEntity, IText, IDescription
{
    public int Id { get; set; }
    public string Text { get; set; }    // Display text
    public string Description { get; set; } // Detailed description
}

These interfaces enable generic handling in UI components, dropdown pickers, and search results.

PersistenceDataType enum

using SplatDev.Umbraco.Pagination.Enums;

var type = PersistenceDataType.Json;

switch (type)
{
    case PersistenceDataType.Json:
        // Serialize to JSON
        break;
    case PersistenceDataType.Xml:
        // Serialize to XML
        break;
    case PersistenceDataType.Binary:
        // Serialize to binary
        break;
}

Pagination model for API requests

// Use as API parameter
[HttpGet]
public IActionResult GetProducts([FromQuery] Pagination pagination)
{
    var results = _service.GetAll(pagination);
    return Ok(results);
}

Features

• PagedResults<T> — Standardized paginated result container
• Pagination — Request model with Page and PageSize properties
• PaginationExtensions — GetTotalPages(), PagedResults<T>(), Shuffle<T>()
• IEntity, IText, IDescription interfaces — Consistent model contracts
• PersistenceDataType enum — JSON, XML, Binary data type enumeration
• Zero Umbraco dependency — Microsoft.AspNetCore.App framework reference only
• Usable in any .NET project, not just Umbraco

Dependencies

No other NuGet dependencies. This is a lightweight, self-contained package with no external library requirements.

Target Frameworks

• net8.0 — for .NET 8 applications
• net10.0 — for .NET 10 applications

SplatDev.Umbraco.Pagination — part of the SplatDev.Umbraco.Plugins suite. Licensed under MIT. © SplatDev Ltda.

Changelog

2.0.5 — 2026-08-24

Removes a dashboard screenshot that showed an error toast. It was captured against a site where this plugin's API was unreachable, so it advertised a broken dashboard. No screenshot is better than a misleading one; a replacement will be taken against a working install.

2.0.4 — 2026-08-24

Package metadata only: the listing now carries an icon and search tags, and the project and repository links point at the organisation that actually hosts this code. No code changes.

2.0.2 — 2026-08-22

• This package's README now reaches NuGet. The publish workflow discovered packages by a list of name patterns, and this one matched none of them, so it was never built or pushed by CI — the version on NuGet was placed there by hand before the README was wired up, and no release could refresh it. Discovery is now by prefix, so the package ships whenever the repo is tagged.