npm 包 redux-filtered-pagination 使用教程

阅读时长 6 分钟读完

简介

redux-filtered-pagination 是一个可用于实现分页的 React Redux 应用程序的插件,它可以对数据进行过滤排序并分页展示。我们可以在前端项目中通过使用这个插件来实现数据的分页展示效果。

在本文中,我们将详细介绍 redux-filtered-pagination 的使用教程,并提供示例代码及其说明。

安装

可以通过在命令行中执行以下命令来安装 redux-filtered-pagination:

快速入门

首先在 Redux store 中添加中间件 filteredPaginationMiddleware:

然后在 UI 组件中使用 PaginationResultsPerPageSelector 组件:

-- -------------------- ---- -------
------ ------ - --------- - ---- --------
------ - ------------ ----------- - ---- --------------
------ ---------- ---- ---------------------------------------
------ ---------------------- ---- ---------------------------------------------------

------ - ---------- - ---- ----------------------

----- ----- - -- -- -
  ----- -------- - --------------
  ------------ -- -
    ---------------------
  -- ------------

  ----- - ------------ ----------- ------------- ------- - - ------------
    ----- -- -----------
  --

  ------ -
    -----
      -----
        ----------------------- --
        ----------- --
      ------
      ----
        ------------------- ------ -- -
          --- ------------
            ------------ ------------
          -----
        ---
      -----
      -----
        ----------- --
      ------
    ------
  --
--

------ ------- ------

配置

分页

在上述示例中,我们使用了 Pagination 组件来实现基本的分页效果。该组件可以接受以下可选参数:

  • pageRangeDisplayed: {number} 显示在页面上的链接数量(默认为 5)。比如当设置为 5 时,会在页面上显示 5 个链接,如 1,2,3,4,5,中间用省略号表示。
  • marginPagesDisplayed: {number} 导航栏两侧超出选定页数的链接数量(默认为 2)。比如当设置为 2 时,会在导航栏两侧,分别显示两个链接,如"1 ... 3 4 5 ... 100"。
  • className: {string} 组件的 class 名称。
  • currentPage: {number} 当前激活的分页索引。
  • totalPages: {number} 总共分页数。
  • onPageChange: {function} 点击分页链接时触发的回调函数。
  • prevLabel: {string} "上一页" 的字符串。
  • nextLabel: {string} "下一页" 的字符串。

使用该组件时,需要在 Redux state 中设置 currentPage 和 totalPages。

每页结果数量选择器

我们可以通过 ResultsPerPageSelector 组件来实现每页结果数量选择器。该组件接受以下可选参数:

  • options: {Array} 每页结果数量可选项,默认值为 [10, 20, 50]。
  • className: {string} 组件的 class 名称。

使用该组件时,需要在 Redux state 中设置 itemsPerPage。

示例代码

下面是一个完整的使用 redux-filtered-pagination 分页插件的示例:

-- -------------------- ---- -------
------ ------ - --------- - ---- --------
------ - ------------ ----------- - ---- --------------
------ ---------- ---- ---------------------------------------
------ ---------------------- ---- ---------------------------------------------------

------ - ---------- - ---- ----------------------

----- ----- - -- -- -
  ----- -------- - --------------
  ------------ -- -
    ---------------------
  -- ------------

  ----- - ------------ ----------- ------------- ------- - - ------------
    ----- -- -----------
  --

  ------ -
    -----
      -----
        ----------------------- --
        ----------- --
      ------
      ----
        ------------------- ------ -- -
          --- ------------
            ------------ ------------
          -----
        ---
      -----
      -----
        ----------- --
      ------
    ------
  --
--

------ ------- ------

结论

本文详细地介绍了如何使用 redux-filtered-pagination 来实现前端项目中的分页效果。

在实际使用中,我们可以根据实际情况自定义组件的样式、计算当前页码及总页码等。我们希望此文能对你实现这个插件有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600568f581e8991b448e4a61

纠错
反馈