:icon-file-code:  JavaScript

!!!tip Add the oj gem to your gemfile It is not a requirement, but if present, the pagy JSON generation will be faster. !!!

Setup

Pick a file...

+++ pagy.mjs

!!!success Good for apps with a minifier (Sprockets, builers, ...) !!!

Make Pagy available in your JavaScript environment with...

import Pagy from "pagy.mjs"

+++ pagy.min.js

!!!success Good for apps without a minifier (Propshaft, Importmaps, ...) !!!

Make Pagy available in your JavaScript environment with...

<%= javascript_include_tag "pagy.min.js" ...%>

<!-- or if your app does not provide helpers -->
<script src="/path/to/pagy.min.js"></script>

+++ pagy.js

!!!warning Use it only for debugging Pagy itself. !!!

+++

{{ include "snippets/pick-a-conf" resource: ":javascript" resource_dir: "javascripts" remote_dir: "app/javascript" }}

Run the Pagy.init on...

+++ "load" event

Pick which applies to your environment:

window.addEventListener("load", Pagy.init)
window.addEventListener("turbo:load", Pagy.init)
window.addEventListener("turbolinks:load", Pagy.init)
window.addEventListener("your-event", Pagy.init)

+++ Stimulus connect

connect() {
  Pagy.init(this.element);
}

+++