npm 包 nui-table 使用教程

阅读时长 6 分钟读完

引言

前端的开发经常会涉及到表格的展示和操作,而 nui-table 就是一款提供了诸如排序、筛选、分页等常用功能的表格组件。本文将从安装、使用和二次定制等方面详细介绍这个 npm 包的使用方法。

安装

在安装之前,需要先安装好 node.js 和 npm,具体可以在官网上下载安装。安装完成后,在终端中输入以下命令:

即可完成 nui-table 包的安装。

使用

要使用 nui-table,需要在项目中引入相关的 css 和 js 文件:

然后在需要使用的地方,使用类似下面的 HTML:

再在 js 中的初始化代码中,按照以下方式调用:

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

其中 data 是数据源,columns 是列定义。这样在运行时,就会生成一个具有常用功能的可交互表格。

深入学习

数据源

通过上述代码可以看到,nui-table 可以通过 data 属性指定数据源。其中数据源除了可以是简单的 JSON 数组对象,也可以是一个返回 JSON 数组的函数。此外,还可以通过一些函数来实现数据的动态加载。比如:

这样就可以实现动态从后端服务器获取数据的效果,只要后端接口符合指定的格式,就能够直接在表格中渲染数据。这种方式相对于直接提供静态的数据,可以减轻前端的数据负载,同时也更利于后端数据的管理和扩展。

列定义

columns 属性定义表格需要显示的列,可以指定每一列对应的数据字段和显示名称,还可以定义其他的一些属性和事件。其中最常用的属性是 sortable(是否可排序)和 filterable(是否可筛选):

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

在这个例子中,通过设置 sortable 和 filterable 的属性,可以分别实现对年龄的排序和对性别的筛选,进一步提供了表格的交互能力。

事件处理

nui-table 还提供了大量的事件处理接口,通过这些接口,可以实现更丰富的定制和交互效果。以下是一个简单的例子:

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

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

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

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

在这个例子中,通过 on 方法监听了 preLoad 和 postLoad 事件。在 preLoad 事件中,可以打印出请求参数和请求地址,并进一步对参数进行处理。在 postLoad 事件中,可以打印出返回结果和数据总数,并进行数据的处理。

二次定制

如果需要在 nui-table 基础上进一步进行定制,可以通过继承 NuiTable 类并重新实现一些方法来实现。

比如以下是一段代码示例,通过继承 NuiTable 并重新实现 _renderTable 方法实现了表格渲染效果的定制:

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

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

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

在这个例子中,通过继承 MyTable 类并重新实现 _renderTable 方法,首先调用了 NuiTable 类原有代码,然后通过修改 ths 的样式实现了表格标题样式的定制。

结语

上述是 nui-table 的基本用法和一些进阶技巧的介绍。当然,nui-table 还提供了许多其他的方法和事件,如果需要更深入的掌握和应用,还需要多方实践和实际开发中的应用。

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

纠错
反馈