npm 包 jupiter-srch 使用教程

阅读时长 8 分钟读完

前言

在前端开发中,经常需要处理大量的数据搜索,使用现成的搜索组件可以大大节省我们的时间成本。在这篇文章中,我将介绍一款使用简单、功能丰富的搜索组件——jupiter-srch。本文将详细介绍该组件的使用方法,涵盖组件的基本功能、高级功能、API接口及示例代码。

jupiter-srch 简介

jupiter-srch 是一款基于 Vue.js 开发的前端组件,拥有高度可定制的搜索过滤器和灵活的搜索条件设定,支持多种形式的匹配规则。同时也具有性能高效、易于维护的优点。

基本功能

jupiter-srch 主要分为两个部分,一部分是搜索输入框,另一部分是搜索结果列表。

输入框

搜索输入框提供了关键字输入和搜索按钮,支持实时输入和点击搜索按钮两种搜索方式。用户可以在输入框中输入关键字,组件支持模糊匹配和完全匹配两种筛选模式。在搜索结果中,关键字会被高亮显示。如果用户没有输入关键字,则在搜索结果中显示全部数据。

搜索结果列表

搜索结果列表展示了符合搜索条件的所有数据,并支持分页显示和排序功能。用户可以设置每页显示数据的数量,并对各列数据进行升降序排列。

高级功能

在基本功能的基础上,jupiter-srch 提供了许多高级功能,使搜索过滤更加灵活和方便。

前缀匹配和后缀匹配

除了基本的模糊匹配和完全匹配,组件还支持前缀匹配和后缀匹配。通过设置搜索条件的 mode 属性,可以选择该属性的匹配规则。当 mode 为 prefix 时,搜索结果将只包含前缀匹配的数据;当 mode 为 suffix 时,搜索结果将只包含后缀匹配的数据。

自定义匹配规则

jupiter-srch 还支持自定义匹配规则,用户可以通过自定义匹配器函数中的参数实现更加细粒度的匹配过滤。例如,可以实现输入 "2015-01" 可以匹配到日期为 "2015-01-01" 的数据,而不是只匹配到 "2015-01" 这个字符串。

前端分页和排序

jupiter-srch 内置了前端分页和排序功能,用户可以通过设置每页显示数据的数量、当前页数和排序方式来实现分页和排序。

API 接口

在使用 jupiter-srch 时,我们需要调用该组件的 API 接口来实现各种功能。

Props

Props 可选值 默认值 说明
data Array [] 要搜索的数据
colHeaders Array [] 表头
colFields Array [] 数据属性
keyword String "" 关键字
mode String fuzzy 匹配模式,可选值为 fuzzy(模糊匹配)、exact(完全匹配)、prefix(前缀匹配)和 suffix(后缀匹配)
pager Object - 分页设置
sort Object - 排序设置

Methods

Methods 说明
filterData 数据过滤函数
sortData 数据排序函数
getPageData 获取指定页码的数据
onPageChange 分页变化事件
onSortChange 排序变化事件
onKeywordChan 关键字变化事件

示例代码

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

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

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

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

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

结语

以上是 jupiter-srch 的使用教程及示例代码,希望能够对大家在前端搜索相关的工作中有所帮助。jupiter-srch 的功能丰富,使用方便,适用于多种场景,如需要搜索过滤的表格、列表等。感谢大家的阅读,如有疑问或建议,欢迎留言交流。

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

纠错
反馈