Skip to content
Tiny Go package for pagination queries and generating page numbers
Go
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md
go.mod
paginator.go

README.md

paginatior

paginator provides a simple abstracting for handling pagination requests and offset/limit generation for HTTP requests. The most common usecase is arbitrary queries that need to be paginated with query params coming in from a UI, for instance, /things/all?page=2&per_page=5. paginator can parse and sanitize these values and provide offset and limit values that can be passed to the database query there by avoiding boilerplate code for basic pagination. In addition, it can also generate HTML-ready page number series (Google search style).

Features

  • 0 boilerplate for reading pagination params from HTTP queries
  • Automatic offset-limit calculator for DB queries
  • Automatic sliding-window HTML pagination generation

image

Usage

    // Initialize global paginator instance.
    pg := paginator.New(paginator.Default())

    // Get page query params from an HTTP request.
    // The params to be picked up are defined in options
    // set by .Default() above.
    p := pg.NewFromURL(req.URL.Query())

    // or, pass page params directly, page and per_page.
    p := pg.New(1, 20)

    // Query your database with p.Offset and p.Limit.
    // Once you get the total number of results back
    // from the database, do:
    p.SetTotal(totalFromDB)

    // Generate HTML page numbers in a template.
    p.HTML()

Example

Check out the Alar dictionary glossary to see paginator in action.

Licensed under the MIT license.

You can’t perform that action at this time.