npm 包 react-mentions-exported-utils 使用教程

1. 背景

react-mentions-exported-utils 是一个用于 React.js 的 npm 包,可以用于在页面元素中实现 @ 提及功能。它提供了一些使用方便的工具函数和组件,可以在项目中使用,方便快捷地实现 @ 提及功能。

在实际项目开发中,实现 @ 提及功能是很常见的需求,比如在社交网络、博客等网站中,用户可以在评论中 @ 提及其他用户,对方会收到通知。此时,需要实现一个完善的 @ 提及功能,包括搜索用户、显示搜索结果、选中用户等功能,这些功能非常复杂,需要开发者花费大量的时间和精力来实现。因此,使用 react-mentions-exported-utils 可以大大地减少项目开发的工作量,并提高开发效率。

2. 安装

要使用 react-mentions-exported-utils,需要先安装它。可以在项目根目录下使用以下命令进行安装:

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

3. 使用教程

3.1. 工具函数

react-mentions-exported-utils 中提供了一些方便的工具函数,可以用于实现 @ 提及的功能。

1. getIndexOfLastMention

getIndexOfLastMention 函数可以用于获取字符串中最后一个 @ 字符的位置。

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

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

2. getSubstringFromIndex

getSubstringFromIndex 函数可以用于获取指定位置之后的子串。

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

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

3. getSubstringUntilIndex

getSubstringUntilIndex 函数可以用于获取指定位置之前的子串。

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

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

4. getKeyword

getKeyword 函数可以用于从字符串中提取关键词。

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

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

5. getPlainString

getPlainString 函数可以用于从字符串中去除 @ 符号,并返回纯文本。

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

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

3.2. 组件

除了工具函数,react-mentions-exported-utils 还提供了一些便于实现 @ 提及功能的组件。

1. MentionsInput

MentionsInput 组件用于显示一个输入框,支持用户在输入过程中输入 @ 符号,并在输入框下方显示匹配搜索结果。

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

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

在上面的代码中,MentionsInput 组件创建了一个输入框,Mention 组件作为其子组件,用于指定需要匹配的字符串、触发字符和搜索结果。

2. Mention

Mention 组件用于指定需要匹配的字符串、触发字符和搜索结果。

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

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

在上面的代码中,Mention 组件指定了触发字符为 @,并指定了需要匹配的字符串数组。

3.3. 示例代码

下面是一个完整的示例代码,用于演示如何在 React.js 项目中使用 react-mentions-exported-utils 实现 @ 提及功能:

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

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

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

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

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

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

在上面的代码中,我们创建了一个包含一个输入框和一个提交按钮的表单。在输入框中,我们使用 MentionsInput 组件和 Mention 组件来实现 @ 提及功能。在 handleSubmit 函数中,我们使用 getKeyword 函数从输入框的值中获取关键词,并在 alert 中显示。

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


猜你喜欢

  • npm 包 angularx-date-picker 使用教程

    介绍 angularx-date-picker 是一个基于 Angular 的日期选择器组件,支持多种日期格式和语言的显示。它是一个开源的 npm 包,通过在 Angular 项目中引入该包,可以快速...

    3 年前
  • npm包:Nodejs-debug使用教程

    前言 Node.js 是用于编写服务器端应用程序的开放源代码、跨平台 JavaScript 运行环境。由于 Node.js 在前端领域具有很高的普及度,因此我们需要了解如何在开发过程中使用 Node....

    3 年前
  • npm 包 monthly 使用教程

    在前端开发中,npm 包是不可或缺的一部分,它们可以让我们在开发过程中更加高效、快速地完成各种任务。而其中一个非常实用的 npm 包是 monthly,它可以帮助我们轻松完成每月的日期计算。

    3 年前
  • npm 包 ngx-ionic-cache 使用教程

    在前端开发中,我们经常需要使用缓存技术来提高页面的访问速度和用户体验。ngx-ionic-cache 是一款可以帮助我们实现缓存功能的 npm 包,可以在 Ionic 应用中使用。

    3 年前
  • npm 包 just-scroll.js 使用教程

    如果你正在开发一个网页应用,并需要实现页面滚动效果,那么 just-scroll.js 这个 npm 包可以为你提供帮助。它是一个用 JavaScript 实现的轻量级、快速的自定义滚动条插件,支持鼠...

    3 年前
  • npm 包 tarnish 使用教程

    什么是 tarnish Tarnish 是一个用于 Node.js 的极简的命令行工具,它可以方便快捷地帮助你在本地搭建一个本地服务器,常常被用于前端开发中测试静态文件,也可以同时支持监听文件变化并自...

    3 年前
  • npm包@caldera-labs/api-client使用教程

    介绍 @caldera-labs/api-client是一个JavaScript框架,用于与Web API进行通信。 该框架主要提供对HTTP请求和响应进行封装,使得在调用API时更加简单和方便。

    3 年前
  • npm包fms-admin-client使用教程

    在前端开发中,我们常常需要使用第三方工具来提高效率和功能。而npm包是我们最常用的一种第三方工具。在这篇文章中,我将向您介绍一个名为fms-admin-client的npm包,并为您提供使用教程。

    3 年前
  • npm包vue-sidebar-menu-gieroj使用教程

    在前端开发中,引用npm包是非常常见的。其中一个非常流行的npm包就是vue-sidebar-menu-gieroj,它提供了一个侧边栏菜单的组件,能够快速帮助我们搭建一个侧边栏菜单,并且还具有灵活的...

    3 年前
  • npm包 ysb-protractor-helper使用教程

    前言 在前端开发中,我们经常需要进行自动化测试。而自动化测试的一个重要工具是Protractor。Protractor是AngularJS团队开发的一款测试框架,它可以自动化测试Angular应用程序...

    3 年前
  • npm 包 @xlab-tech/rxcolletion 使用教程

    引言 在前端应用中,数据操作是一个不可避免的问题。但是,对于很多初学者来说,数据操作却是一个十分困难的问题。如何在前端应用中高效地进行数据操作呢?npm 包 @xlab-tech/rxcolletio...

    3 年前
  • npm 包 svg-reacticons 使用教程

    前言 在 Web 开发中,常常会使用图标来装饰页面或作为按钮的标志。svg-reacticons 是一个方便快捷的 npm 包,可以帮助我们快速调用预先定义好的 svg 图标。

    3 年前
  • npm 包 @okvue/vuex-bind 使用教程

    在前端开发中,使用状态管理工具可以帮助我们更好地管理应用程序的状态,从而提高开发效率。Vuex 是一个官方的状态管理工具,但在开发过程中手动绑定 state 和 getters 到组件中需要重复编写一...

    3 年前
  • npm 包 api-shared 使用教程

    在前端开发中,我们常常需要使用一些公共的工具包,以便更快、更高效地完成我们的工作。其中,npm 是极为常用的一种包管理工具,它帮助我们轻松地管理各种库、框架和工具。

    3 年前
  • npm 包 react-datepicker-custom-after-html 使用教程

    简介 react-datepicker-custom-after-html 是一个用于 React 项目的日期选择器组件。与其他日期选择器组件不同的是,react-datepicker-custom-...

    3 年前
  • npm 包 zanm 使用教程

    在前端开发中,我们经常需要将一些常用的交互组件封装成一个 npm 包,以便于在不同的项目中复用,提高开发效率。今天我要介绍的是 zanm 这个 npm 包,它是一个轻量级移动端交互组件库,具有高度的可...

    3 年前
  • npm 包 open-on-npm 使用教程

    什么是 npm? 在开始介绍 npm 包 open-on-npm 使用教程之前,我们先来了解一下什么是 npm。npm 是 Node.js 的包管理器,它的作用是能够方便地安装、升级、删除并管理 No...

    3 年前
  • npm 包 taskbook-ext 使用教程

    taskbook-ext 是一款非常实用的 npm 包,它可以帮助前端开发者更加高效地管理自己的项目。本文将提供 taskbook-ext 的详细使用教程,并包含示例代码,希望对你的学习和实践有帮助。

    3 年前
  • npm 包 terminal-game-io 使用教程

    在前端开发中,我们不仅要开发网页,还需要开发小游戏来增加用户的体验。而使用 npm 包 terminal-game-io 就可以方便地开发控制台游戏。本文将为你详细介绍 terminal-game-i...

    3 年前
  • npm 包 ysb-protractor-grunt-runner 使用教程

    ysb-protractor-grunt-runner 是一个基于 grunt 实现的前端自动化测试工具,主要用于测试 AngularJS 应用。本教程将介绍该工具的使用方法,包括安装、配置和使用。

    3 年前

相关推荐

    暂无文章