Astral.Pagination.Page (Astral v0.1.8)

Copy Markdown View Source

A single static pagination page.

The field names follow common Elixir pagination conventions from libraries such as Scrivener while adding route URLs needed by static site generation.

Summary

Functions

Build a pagination page struct.

Types

t()

@type t() :: %Astral.Pagination.Page{
  entries: list(),
  page_number: pos_integer(),
  page_size: pos_integer(),
  total_entries: non_neg_integer(),
  total_pages: pos_integer(),
  urls: Astral.Pagination.URLs.t()
}

Functions

new(opts)

@spec new(keyword()) :: t()

Build a pagination page struct.