Getting Started

Installation

go get github.com/ishinvin/pageable

Requires Go 1.21+ (uses generics).

Import

import "github.com/ishinvin/pageable"

Choose Your Pagination Style

StyleBest ForTrade-offs
Offset-based Admin panels, dashboards, "jump to page N" Requires COUNT query; inconsistent on live data
Cursor-based Feeds, infinite scroll, real-time data No page jumping; more efficient at scale

Defaults

ConstantValueDescription
DefaultPage1Default page number (1-indexed)
DefaultSize10Default items per page
MaxSize1000Maximum allowed page size
DefaultCursorSize10Default cursor page size
MaxCursorSize1000Maximum cursor page size