Pagination

Katalyst::Tables::Collection::Pagination adds pagination support for a collection.

This gem is designed to work with pagy.

If you use collections and enable pagination, then pagy will be called internally and the pagy metadata will be available as pagination on the collection.

Usage

Pagination will be applied if the collection is configured with a default pagination configuration. This can be done by either specifying a default config on the collection or by passing a pagination configuration to the initializer.

Collection Configuration

class Collection < Katalyst::Tables::Collection::Base
  config.paginate = true
end

Passing options to pagy

class Collection < Katalyst::Tables::Collection::Base
  config.paginate = { limit: 10 }
end

Initializer Configuration

Katalyst::Tables::Collection::Base.new(paginate: true)

Passing options to pagy

Katalyst::Tables::Collection::Base.new(paginate: { limit: 10 })

When pagination is enabled, table rows will be automatically paginated prior to rendering the table. The pagy metadata will be available as pagination for you to use your preferred method of pagination control rendering.

See frontend pagination for details.