npm 包 empt 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

介绍

empt 是一个小巧的 JavaScript 库,用于在 HTML 页面中将文本内容转换为带有关键词高亮的 HTML 片段。它支持多种高亮风格,并且使用简单方便。

安装

使用 npm 安装 empt

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

或者直接从 GitHub 仓库 下载源码。

使用

基础用法

首先,将 empt 引入项目中:

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

或者通过 import 引入:

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

然后,定义一个文本字符串和一个关键词数组:

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

最后,传入 textkeywords,以及一个目标元素的选择器,即可完成高亮转换:

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

在 HTML 中,定义一个空元素用于存放高亮结果:

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

高级用法

empt 还支持更多的自定义选项和事件回调,以实现更灵活的高亮效果。

配置选项

可以使用 options 参数定义一些自定义选项:

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

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

自定义高亮模板

默认情况下,empt 会将关键词用 <mark> 标签包裹起来,可以通过 replaceFn 选项传入一个自定义函数来实现自定义高亮模板:

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

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

手动触发高亮

使用 start()stop() 方法手动触发和停止高亮:

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

获取分组结果

使用 getGroupedMatches() 方法获取按关键词分组的匹配结果:

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

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

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

示例代码

HTML:

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

JavaScript:

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

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

结语

empt 是一个非常实用的小型库,可以在开发过程中快速实现文本高亮功能。希望本文的介绍和示例能够帮助你更好地使用它。

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


猜你喜欢

  • npm 包 enfscopy 使用教程

    前言 在应用开发中,文件的操作非常常见。Node.js 环境中自带的 fs 模块可以让我们方便地进行文件读写操作。但是,当我们需要对一个文件进行操作时,我们通常需要做一些保险措施,以备意外情况发生,在...

    4 年前
  • npm 包 enfsensure 使用教程

    前言 在前端开发中,我们经常需要读写本地文件和目录。Node.js 提供了文件系统模块(fs)用于处理文件和目录相关的操作。但是,使用原生的 fs 模块进行文件操作时,我们需要写很多冗长的代码来判断文...

    4 年前
  • npm 包 enfsmkdirp 使用教程

    介绍 enfsmkdirp 是一个 Node.js 的 npm 包,它提供了一种简便的方式来创建目录和文件。它可以自动创建不存在的目录层级,并且可以通过选项来控制各个层级的权限。

    4 年前
  • npm 包 enfsmove 使用教程

    在前端开发中,经常需要操作文件和目录,Node.js 提供了 fs 模块来进行文件操作。但是在使用 fs 模块时,需要编写冗长的代码逻辑,因此,我们可以使用第三方 npm 包来优化操作文件和目录的体验...

    4 年前
  • npm 包 eng-drive 使用教程

    简介 eng-drive 是一个 npm 包,它可以帮助前端开发人员快速搭建基于 webpack 构建工具的本地开发环境。使用 eng-drive,你可以不需要手动配置 webpack,并且可以使用多...

    4 年前
  • npm 包 eng-ng-semantic 使用教程

    前端工程化已经成为了现代化前端开发的一大趋势,工程化开发所需的工具和框架也越来越多,而在这些工具和框架中,npm 包的重要性不言而喻。npm 包的使用可以帮助我们快速解决各种问题,提高开发效率。

    4 年前
  • npm 包 eng-pron 使用教程

    前言 在前端项目中,有时候需要对英语单词进行发音,以便更好地学习和理解单词的意义。这时候可以使用 eng-pron 这个 npm 包来进行单词发音。eng-pron 是一个基于 Merriam-Web...

    4 年前
  • npm 包 engage 使用教程

    简介 engage 是一个 Node.js 的 npm 包,它提供了一种便捷的方式来管理和调用 RESTful APIs。它支持灵活的配置和多种缓存策略,可以在 Node.js 服务端以及浏览器端使用...

    4 年前
  • npm 包 engage-api 使用教程

    前言 engage-api 是一款适用于前端开发的 npm 包,它提供了与 Engage 平台的 API 接口进行交互的能力。Engage 是一个在线教育平台,开发者可以通过它提供的 API 接口来实...

    4 年前
  • npm 包 engage-api-examples 使用教程

    简介 EngageApiExamples 是一个 Node.js 模块,用于访问和操作 Engage API。Engage API 是一个可以让您使用 HTTP 请求与 Oracle 天幕云服务打交道...

    4 年前
  • npm 包 engage-config 使用教程

    介绍 在前端开发中,我们经常需要引用各种第三方库或者自己在不同场景中使用不同的配置项。而在 Node.js 中,使用一个名为 npm 的包管理工具来管理这些依赖。engage-config 是一个 N...

    4 年前
  • npm 包 engage-eslint-summary 使用教程

    简介 在前端开发中,代码质量是至关重要的。使用 eslint 可以帮助我们检查代码中的潜在错误和规范问题,提高代码的可读性和可维护性。而 engage-eslint-summary 这个 npm 包则...

    4 年前
  • npm 包 enquirer-prompt 使用教程

    在前端开发中,我们经常需要与用户进行交互,如输入数据、选择选项等。Node.js 为我们提供了一个方便的工具:enquirer-prompt。该工具是一个 npm 包,可以帮助我们快速编写与用户交互的...

    4 年前
  • npm 包 enquirer-prompt-checkbox 使用教程

    前言 在前端开发中,我们常常需要编写表单或者交互式 CLI 工具。而 enquirer-prompt-checkbox 就是一个非常有用的 npm 包,它可以帮助我们快速的生成复选框。

    4 年前
  • 使用 enquirer-prompt-input 包获取用户输入

    在前端开发中,我们常常需要获取用户的输入来进行后续的处理。虽然在 HTML 表单中也有输入框可以用来接收用户输入,但很多时候我们需要在前端代码中动态获取用户输入,并在代码中进行相应的处理。

    4 年前
  • npm 包 enquirer-prompt-confirm 使用教程

    在前端开发过程中, 有时候需要获取用户的确认, 以便决定下一步的操作. 例如: 当用户在进行删除操作时, 可能需要询问用户是否确定删除. 在这种场景下, 通常需要使用一种方便且易于使用的解决方案, 这...

    4 年前
  • npm 包 enviar 使用教程

    前言 enviar 是一款针对浏览器或 Node.js 的跨平台发送和接收消息的 npm 包,可以用于在不同的浏览器窗口或不同的 Node.js 进程之间方便地交换数据。

    4 年前
  • npm 包 envif 使用教程

    前言 在前端开发过程中,可能会出现需要在不同开发环境中进行不同的操作,例如在开发环境中需要打印调试信息,在生产环境中则不需要。为了解决这种情况,我们可以使用 npm 包 envif。

    4 年前
  • npm 包 envify-loader 使用教程

    前言 在前端开发中,我们经常会遇到需要根据环境变量进行不同行为的需求,比如根据环境变量对后端接口的地址进行配置。而在 webpack 打包中,经常需要根据环境变量进行不同的配置,这时候我们就需要用到 ...

    4 年前
  • npm 包 envig 使用教程

    在前端开发过程中,我们经常需要使用环境变量来配置和管理我们的 App。而 envig 是一种可以通过脚本文件自动创建和测试环境变量的 npm 包。本文将详细介绍 envig 的安装、使用和测试方法。

    4 年前

相关推荐

    暂无文章