#

# Options Hierarchy

---

Pagy has a top-down hierarchical options system that allows you to set and override options at different levels.

# Global level

• For example Pagy::OPTIONS[:limit] = 10.
• Set in the pagy.rb initializer.
• The Pagy::OPTIONS are inherited by all paginators and helpers.
• You can set all kinds of options at the global level, no matter which is the destination downstream (i.e., paginator or helper).
• Notice: Using the legacy Pagy.options accessor is discouraged but supported.
• IMPORTANT: Freeze it after you are done in the initializer, for good safe practice.

# Paginator level

• For example pagy(paginator, collection, **options).
• The options passed to a paginator override the Pagy::OPTIONS set upstream for that instance.

# Helper level

• For example @pagy.series_nav(**options).
• The options passed to a helper override all the upstream options for its output.
• The options consumed upstream are not affected.