Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 834 Bytes

README.md

File metadata and controls

33 lines (24 loc) · 834 Bytes

TurnThePage

Fast, simple and lightweight pagination system for your Elixir application.

Installation

If available in Hex, the package can be installed by adding turn_the_page to your list of dependencies in mix.exs:

def deps do
  [
    {:turn_the_page, "~> 0.2.2"}
  ]
end

Usage

Usage is very simple. All you need to is apply it in your DB pipeline.

It works with Module's name, Ecto.Query and regular lists.

Example

User
|> TurnThePage.paginate(page: 2, limit: 15) # it returns Ecto.Query
|> Repo.all()

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/turn_the_page.