© 2017-2021 Domizio DemichelisMIT License

➡ Chat Support on Gitter ➡

Items Extra

Allow the client to request a custom number of items per page with an optional selector UI. It is useful with APIs or user-customizable UIs.

It works also with the countless, searchkick, elasticsearch_rails and meilisearch extras.

Synopsis

See extras for general usage info.

In the pagy.rb initializer:

require 'pagy/extras/items'

# it will work without any further configuration

# you can disable it explicitly for specific requests
@pagy, @records = pagy(Product.all, items_extra: false)

# or...

# disable it by default (opt-in)
Pagy::DEFAULT[:items_extra] = false   # default true
# in this case you have to enable it explicitly when you want it
@pagy, @records = pagy(Product.all, items_extra: true)

# customize the defaults if you need to
Pagy::DEFAULT[:items_param] = :custom_param       # default :items
Pagy::DEFAULT[:max_items]   = 200                 # default 100

See Javascript (only if you use the pagy_items_selector_js UI)

Files

Variables

Variable Description Default
:items_extra enable or disable the feature true
:items_param the name of the items param used in the url. :items
:max_items the max items allowed to be requested. Set it to nil for no limit. 100

You can use the :items_extra variable to opt-out of the feature even when the extra is required.

This extra uses the :items_param variable to determine the param it should get the number of :items from.

The :max_items is used to cap the number of items to that max. It is set to 100 by default. If you don’t want to limit the max requested number of items per page, you can set it to nil.

You may want to customize the variables. Depending on the scope of the customization, you have a couple of options:

As a global default:

Pagy::DEFAULT[:items_param] = :custom_param
Pagy::DEFAULT[:max_items]   = 50

For a single instance (overriding the global default):

pagy(scope, items_param: :custom_param, max_items: 50)
Pagy.new(count: 100, items_param: :custom_param, max_items: 50)

Notice: you can override the items that the client sends with the params by passing the :items explicitly. For example:

# this will ignore the params[:items] (or any custom :param_name)
# from the client for this instance, and serve 30 items
pagy(scope, items: 30)

Methods

The items extra adds the pagy_items_selector_js helper to the Pagy::Frontend module.

pagy_items_selector_js(pagy, …)

This helper provides an items selector UI, which allows the user to select any arbitrary number of items per page (below the :max_items number) in a numeric input field. It looks like:

Show items per page

It returns an empty string if the :items_extra is false.

The method accepts also a few optional keyword arguments:

Notice the :i18n_key can be passed also to the constructor or be a less useful global variable (i.e. Pagy::DEFAULT[:i18n_key]

<%== pagy_items_selector_js(@pagy, item_name: 'Product'.pluralize(@pagy.count) %>
<%== pagy_items_selector_js(@pagy, i18n_key: 'activerecord.model.product' %>

Show Products per page

(see Customizing the item name)

When the items number is changed with the selector, pagy will reload the pagination UI using the selected items per page. It will also request the right page number calculated in order to contain the first item of the previously displayed page. That way the new displayed page will roughly show the same items in the collection before the items change.

This method can take an extra id argument, which is used to build the id attribute of the nav tag. Since the internal automatic id generation is based on the code line where you use the helper, you must pass an explicit id if you are going to use more than one *_js call in the same line for the same file.

Notice: passing an explicit id is also a bit faster than having pagy to generate one.