npm 包 datatables.net-scroller-bs4 使用教程

阅读时长 10 分钟读完

近几年来,前端技术正在迅速发展,越来越多的优秀的工具和库涌现出来。npm 是前端开发中非常重要的一个工具,它为开发者提供了大量的模块和包,让我们的开发变得更加高效快捷。其中,datatables.net-scroller-bs4 也是一个非常实用的 npm 包,它是基于 datatables 的插件,能够实现在大数据量下的无限滚动加载,针对使用 bootstrap 4 样式的 datatables 做了特殊的定制。

在这篇文章中,我们将深入介绍 datatables.net-scroller-bs4 的使用方法,并结合实例代码,让你轻松上手。

安装

在开始之前,我们需要通过 npm 安装 datatables 和 datatables.net-scroller-bs4。

基础使用

首先,我们需要在 HTML 中引入 DataTables 和 Scroller 插件的 CSS 样式和 JavaScript 文件,以及相关的 Bootstrap 4 样式文件。

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

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

---- --------- ---- ---
----- ------------------------------------------------------------------------------ ---------------- --------------- --
----- ---------------------------------------------------------------------------- ---------------- --------------- --
----- -------------------------------------------------------------------------------- ---------------- --------------- --
展开代码

接着,我们可以通过 jQuery 的方式来调用 datatables 和 datatables.net-scroller-bs4。

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

  -- -- -------- --
  ----------------
    -- -------- --
  ---
---
展开代码

这样,一个基本的可滚动的 DataTables 就完成了。

Scroller 配置

在使用 Scroller 插件时,我们可以配置一系列参数,以实现更多的功能。

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

  -- -------- --
  --- -------- - --- ------------------------------ -
    ---------- --------
    ------------------- -----
    ---------------- --
    ---------------- ----
    ------------- ----
    -------------------- -------- ---------- --------- -
      --- --- - --- -----------------------------
      --- ---- - ------------------------------------------------------- - ---------------------
      -- ------ -
        --------------------------
      -
      -----------
    --
    -------------------- -------- ---------- ----- -
      ------------------------------------------- - ------------------- ----------------------
    -
  ---
---
展开代码

这里我们以 Scroller 实现无限滚动加载举例。

  • scrollY:设置 Scroller 的滚动高度。
  • loadingIndicator:设置是否展示加载中的提示信息。
  • displayBuffer:设置提前想加载多少行数据到缓存等待滚动。
  • boundaryScale:设置当 Scroller 达到顶部和底部边界时,它应该向上或向下滚动多少像素。
  • serverWait:若 Scroller 滑动,与 Ajax 请求之间的等待时间(毫秒)。
  • stateLoadCallback:设置加载缓存数据的回调函数。
  • stateSaveCallback:设置缓存数据的回调函数。

示例代码

下面,我们以实际的案例来演示 datatables.net-scroller-bs4 的使用方法。我们准备了一份 5000 条数据的 JSON 数据,可以通过 AJAX 获取。

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

  --- -------- - --- ------------------------------ -
    ---------- --------
    ------------------- -----
    ---------------- --
    ---------------- ----
    ------------- ----
    -------------------- -------- ---------- --------- -
      --- --- - --- -----------------------------
      --- ---- - ------------------------------------------------------- - ---------------------
      -- ------ -
        --------------------------
      -
      -----------
    --
    -------------------- -------- ---------- ----- -
      ------------------------------------------- - ------------------- ----------------------
    -
  ---
---
展开代码

总结

通过本文的介绍,我们了解了如何通过 npm 包 datatables.net-scroller-bs4 来实现无限滚动加载。同时,我们也学习了如何配置 Scroller 和 DataTables 以实现更多的功能。希望这篇文章能对你在使用 datatables.net-scroller-bs4 时有所帮助。

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