npm 包 ngx-smart-search 使用教程

介绍

ngx-smart-search 是一个Angular的可重用组件,旨在为搜索场景提供高效的解决方案。它具有快速响应,具有适应性和易于使用等优点,非常适合于需要按特定条件对数据列表进行搜索的场景。

功能特性

  • 按字段搜索
  • 模糊搜索
  • 支持多个字段搜索
  • 计数器显示搜索结果数量
  • 清除搜索内容
  • 双向绑定搜索关键字

安装

打开终端,切换至项目根目录,执行以下命令:

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

用法

在需要使用 ngx-smart-search 的组件中添加以下代码:

导入模块

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

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

添加搜索框

以下是一个简单的例子:

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

API

输入属性

data

数据列表。必填项。

----- ------

placeholderText

搜索框中的占位符文本。

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

searchFields

搜索用到的字段,支持多个。

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

debounceTime

搜索 debounce 时间,单位为毫秒。

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

输出属性

search

搜索事件,当输入框中的内容发生变化时就会触发。

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

clear

清除按钮事件,当点击搜索框右侧的清除按钮时就会触发。

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

SearchKeyword

搜索关键字对象。

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

示例代码

以下是一个使用 ngx-smart-search 进行用户列表搜索的例子:

在组件中添加以下代码

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

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

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

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

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

User 对象

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

结论

ngx-smart-search 是一个非常好用的 Angular 搜索组件,它的使用非常简单且强大,多个属性和事件满足不同的需求;现在你可以使用 ngx-smart-search 解决任何搜索场景的问题啦!

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60056be881e8991b448e5a25


猜你喜欢

  • npm 包 template-saas-theme 使用教程

    前言 前端开发是一项需要不断学习和探索新技术的工作,其中 npm 包的应用非常广泛,可以方便地将别人开发好的代码引入到项目中,避免重复造轮子。在本文中,我们将介绍一款常用的 npm 包 templat...

    3 年前
  • npm 包 videojs-immerxon 使用教程

    在前端开发中,视频播放是非常常见的一种需求。为了方便快速地实现视频播放功能,我们可以使用许多现有的 npm 包来降低开发难度。其中,videojs-immerxon 是一个功能强大的 npm 包,它可...

    3 年前
  • npm 包 grow-element-fn 使用教程

    在前端开发过程中,使用现有的 npm 库是非常常见的。 npm 是目前最大的软件注册表,也是 JavaScript 生态系统中的核心组成部分。其中一个非常有用的 npm 包是 grow-element...

    3 年前
  • npm 包 file-find 使用教程

    在前端开发中,文件的查找和操作是必不可少的。npm 包 file-find 就是一个非常好用的文件查找工具,让我们更轻松地完成文件的操作。 安装 使用 npm 安装 file-find: --- --...

    3 年前
  • npm 包 with-node-env 使用教程

    介绍 with-node-env 是一个 npm 包,可以让我们在编写 Node.js 应用时更加方便地使用不同的环境变量。 在 Node.js 中,我们可以使用 process.env 来访问环境变...

    3 年前
  • npm 包 casino 使用教程

    引言 在前端开发中,我们经常使用一些 npm 包来完成某些任务,提高开发效率。今天我要介绍的是一个 npm 包 casino,它是一个用于生成随机数字和字母的 JavaScript 库。

    3 年前
  • npm 包 generator-codexmedia 使用教程

    简介 在前端开发中,我们经常需要使用一些工具来加速开发效率,如构建工具、脚手架等。而 generator-codexmedia 就是一个可以帮助我们快速生成前端项目的 npm 包。

    3 年前
  • npm 包 generator-lemon-ts 使用教程

    在前端开发中,我们常常需要创建一些重复的代码文件。为了避免重复劳动,我们可以使用 Yeoman 工具来自动创建项目结构。其中一个非常好用的 Yeoman 生成器是 generator-lemon-ts...

    3 年前
  • npm 包 generator-react-component-boilerplate 使用教程

    什么是 generator-react-component-boilerplate? generator-react-component-boilerplate 是一个 npm 包,它可以生成一个基础...

    3 年前
  • npm 包 @longweiquan/plywood-postgres-requester 使用教程

    简介 @longweiquan/plywood-postgres-requester 是一个用于连接 PostgreSQL 数据库的 Node.js 模块。它基于 plywood-postgres-r...

    3 年前
  • npm 包 react-native-keycloak 使用教程

    简介 Keycloak 是一款开源的身份认证和访问授权管理平台,react-native-keycloak 则是一款基于 Keycloak 的 React Native 插件。

    3 年前
  • npm 包 json-parser-so-spec 使用教程

    在前端开发中,经常需要解析 JSON 数据。而针对 JSON 格式的数据解析,我们可以使用一些常见的工具和库,比如原生 JSON 对象、第三方库 JSON.parse() 或者 jQuery.pars...

    3 年前
  • npm 包 itee-boilerplate 使用教程

    简介 npm 是 Node.js 平台上的一个全球最大的包管理器,对于前端开发者来说,使用 npm 包可以方便快捷地获取需要的第三方库,进而提高开发效率。itee-boilerplate 是一个为了支...

    3 年前
  • npm 包 react-router-preload-core 使用教程

    什么是 react-router-preload-core? react-router-preload-core 是一个 React 路由预加载的核心库,可以帮助开发者预先加载页面组件和相关资源,提高...

    3 年前
  • npm 包 react-router-preload-tree 使用教程

    介绍 react-router-preload-tree 是一个能够帮助 React 开发者快速、高效地预加载路由页面资源的 npm 包。 当我们进行 React 项目开发时,经常会遇到一些需要做路由...

    3 年前
  • npm 包 svgo-inline-loader 使用教程

    什么是 svgo-inline-loader svgo-inline-loader 是一个 webpack loader,用于将 SVG 图标文件转换为可嵌入 HTML 中的内联 SVG。

    3 年前
  • npm 包 swarm-ron-grammar 使用教程

    简介 Swarm-ron-grammar 是一个基于 JavaScript 的 NPM 包,用于实现语法解析和代码转换的功能。它可以通过预定义的语法规则,将一种编程语言(比如 Java 或 C++)的...

    3 年前
  • npm 包 Swarm-ron-uuid 使用教程

    介绍 Swarm-ron-uuid 是一款基于 JavaScript 编写的 NPM 包,它提供了一种用于生成全局唯一标识符 (GUID) 的算法。该算法基于 SWARM 和 RON 技术,可以有效地...

    3 年前
  • npm 包 tech-radar-google-trends 使用教程

    简介 tech-radar-google-trends 是一个基于 Google Trends API 打造的 npm 包,专门用于前端开发中对技术趋势的分析和可视化呈现。

    3 年前
  • npm 包 xsvd 使用教程

    概述 xsvd 是一个用于 Flash/外部 RAM 编程器的命令行工具,支持多种调试器、不同的文件格式以及各种芯片。 在前端开发中,我们可能需要将代码编译成可执行文件或数据存储在设备上,而这些设备往...

    3 年前

相关推荐

    暂无文章