#

# 💚 Initializer

You can use the initializer to configure pagy for your app.

# Inheritable Options

Pagy has an inheritable options system that allows you to set and override options at three different levels:

Global level
- Pagy.options (set in the initializer)
- The Pagy.options are inherited by all paginators, instances, and methods.
Paginator level
- e.g.: pagy(paginator, collection, **options)
- The options passed to the paginator override the Pagy.options and are inherited by the @pagy instance.
Methods level
- e.g.: @pagy.nav_tag(**options)
- The options passed to the methods override all other options.

Keep options local
- For clarity, set options as close as possible to where they're used.
Widen options when needed
- Use higher-level options when they conveniently affect broader scopes.

# Initializer file

Download or copy the small file below and ensure it loads (e.g., save it into the Rails config/initializers directory or require it). Read its comments for details.

pagy.rb

pagy.rb 1.91KB

pagy.rb
# frozen_string_literal: true

# Pagy initializer file (10.0.0)
# See https://ddnexus.github.io/pagy/toolbox/initializer/

############ Global Options ################################################################
# Add your global options below. They will be applied globally.
# For example:
#
# Pagy.options[:limit] = 10               # Limit the items per page
# Pagy.options[:requestable_limit] = 100  # The client can request a limit up to 100
# Pagy.options[:max_pages] = 200          # Allow only 200 pages
# Pagy.options[:jsonapi] = true           # Use JSON:API compliant URLs


############ JavaScript ####################################################################
# See https://ddnexus.github.io/pagy/resources/javascript/ for further details.
# Examples for Rails:
# For apps with an assets pipeline
# Rails.application.config.assets.paths << Pagy::ROOT.join('javascript')
#
# For apps with a javascript builder (e.g. esbuild, webpack, etc.)
# javascript_dir = Rails.root.join('app/javascript')
# Pagy.sync_javascript(javascript_dir, 'pagy.mjs') if Rails.env.development?


############# Overriding Pagy::I18n Lookup #################################################
# Refer to https://ddnexus.github.io/pagy/resources/i18n/ for more information.
# Override the dictionary lookup for customization by dropping your customized
# Example for Rails:
#
# Pagy::I18n.pathnames << Rails.root.join('config/locales')


############# Calendar Localization for non-en locles ###########################
# Add your desired locales to the list and uncomment the following line to enable them,
# regardless of whether you use the I18n gem for translations or not, whether with
# Rails or not.
#
# Pagy::Calendar.localize_with_rails_i18n_gem(*your_locales)


############# I18n Gem Translation #########################################################
# See https://ddnexus.github.io/pagy/resources/i18n/
#
# Pagy.translate_with_the_slower_i18n_gem!