Pagy分页库快速入门指南

Pagy分页库快速入门指南

pagy ddnexus/pagy: 是一个用于 Ruby 和 Rails 的分页库。适合对 Ruby 和 Rails 有兴趣的人，特别是想为自己的 Ruby on Rails 项目添加分页功能的人。特点是提供了一个简洁易用的分页库，可以方便地与 Ruby on Rails 项目集成，支持多种分页样式和自定义选项，具有高可扩展性和易用性。 项目地址: https://gitcode.com/gh_mirrors/pa/pagy

Pagy是一款高效、轻量级的Ruby分页解决方案，专为现代Web应用设计。本文将带你快速了解如何在不同场景中使用Pagy。

1. 安装Pagy

Pagy提供了多种安装方式，适应不同项目需求。

使用Bundler安装（推荐）

在Gemfile中添加以下内容，使用波浪线约束可以避免未来可能出现的重大版本变更：

gem 'pagy', '~> 9.3'

手动安装

通过命令行直接安装：

gem install pagy

然后在Ruby文件中引入：

require 'pagy'

2. 配置Pagy

Pagy的配置非常灵活，可以根据项目需求进行调整。

Rails项目配置

将Pagy配置文件下载并放置在config/initializers目录下。这个文件包含了所有默认配置，你可以根据需要进行修改。

非Rails项目配置

同样下载配置文件，但需要在应用启动时手动引入。

重要提示：Pagy采用按需加载策略，不会在应用中加载不必要的代码。你需要在配置文件中显式声明需要使用的额外功能（extras），并可以在此文件中定制全局默认变量。

3. 后端集成

Pagy的后端集成非常简单，只需几行代码即可完成。

基础集成方式

在控制器中包含后端模块：

include Pagy::Backend

然后在控制器动作中使用pagy方法：

@pagy, @records = pagy(Product.some_scope)

特殊场景支持

Pagy还支持多种特殊分页需求：

• 搜索引擎分页（Elasticsearch、Meilisearch、Searchkick等）
• 日历分页
• 无计数分页（Countless）
• 变速分页（Geared）
• 增量分页（Incremental/Auto-incremental/Infinite）
• 键集分页（Keyset）

4. 前端渲染

Pagy提供了多种前端渲染方式，适应不同的技术栈。

服务器端渲染

1. 在帮助模块中包含前端代码：

include Pagy::Frontend

2. 在视图中使用分页助手：

<%== pagy_nav(@pagy) %>

3. 选择样式方案：

• 可以使用原生Pagy样式
• 也可以集成Bootstrap、Bulma等流行CSS框架

JavaScript框架集成

对于Vue.js、React.js等前端框架：

1. 启用元数据额外功能
2. 在JSON响应中包含分页元数据

API服务

构建API服务时：

1. 考虑使用键集分页（Keyset），特别适合大数据集
2. 启用头部额外功能
3. 在响应中添加分页头部信息

试用Pagy

在正式集成到项目前，你可以通过以下方式体验Pagy：

1. 命令行交互式演示：

gem install pagy
pagy demo

然后访问http://0.0.0.0:8000

2. 直接在IRB控制台中试用所有方法和功能

Pagy以其简洁的API和卓越的性能，成为Ruby生态中分页解决方案的优选。通过本指南，你应该已经掌握了Pagy的基本使用方法，可以开始在项目中集成这一强大的分页工具了。

pagy ddnexus/pagy: 是一个用于 Ruby 和 Rails 的分页库。适合对 Ruby 和 Rails 有兴趣的人，特别是想为自己的 Ruby on Rails 项目添加分页功能的人。特点是提供了一个简洁易用的分页库，可以方便地与 Ruby on Rails 项目集成，支持多种分页样式和自定义选项，具有高可扩展性和易用性。 项目地址: https://gitcode.com/gh_mirrors/pa/pagy