npm 包 @mcallistersean/react-githubish-mentions 使用教程

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

随着社交网络的发展,@提及功能已经成为了现代应用中不可或缺的一部分。如果你想在你的 React 应用中实现这个功能,你可以使用 npm 包 @mcallistersean/react-githubish-mentions。这个包提供了 GitHub 风格的 @提及功能,可以轻松地集成到你的应用中。

安装和引入

首先,你需要使用 npm 安装该包:

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

接着,在你的 JS 文件中引入这个包:

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

基本用法

在你的 React 组件中,你可以使用 组件来实现 @提及功能。

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

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

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

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

这样,当用户输入 "@" 并开始输入用户名时,该组件将在下拉框中展示可能的匹配项。

属性列表

MentionsInput 组件支持以下属性:

属性名 类型 必填 默认值 描述
value string 输入框的值
onChange function 值改变时的回调函数
placeholder string '@' 输入框中默认提示文本
displayTransform function 显示在输入框中的文本变换函数
markup string @[__display__](__id__) 生成的标记格式
trigger string '@' 触发匹配的字符
data array 可用于匹配的数据数组

value

输入框的值。

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

onChange

值改变时的回调函数。

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

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

placeholder

输入框中默认提示文本。

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

displayTransform

显示在输入框中的文本变换函数。

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

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

markup

生成的标记格式。

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

trigger

触发匹配的字符。

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

data

可用于匹配的数据数组。

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

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

示例代码

下面是一个使用 @mcallistersean/react-githubish-mentions 包的示例代码:

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

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

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

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

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

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

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

这个组件将自动匹配用户列表中的用户名,并将它们显示为链接格式。你也可以在 displayTransform 函数中定义自己的格式化规则,或者修改 markup 的格式来自定义标记格式。

总结

@mcallistersean/react-githubish-mentions 包提供了一个快速的方式来实现常见的 @提及功能。通过使用这个包,你可以轻松地在你的 React 应用中实现这个功能,并可以根据你的需求自定义格式和匹配规则。当你需要在你的应用中实现 @提及功能时,这个包值得你的一试。

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


猜你喜欢

  • npm 包 unicorn-names 使用教程

    前言 随着前端技术的快速发展,npm 成为了前端开发中不可或缺的一部分。npm 包提供了丰富的开发资源,使得我们可以轻松地引入和使用其他开发者和组织提供的工具和插件。

    3 年前
  • npm 包 flow-test 使用教程

    Flow 是一个由 Facebook 推出的 JavaScript 静态类型检查工具,可以帮助开发者在开发过程中发现类型和错误,提高代码的可读性和可维护性。而 flow-test 是一个基于 Flow...

    3 年前
  • npm 包 jm-bank-mqtt 使用教程

    介绍 jm-bank-mqtt 是一个基于 MQTT 协议的前端包,旨在提供简单快捷的方法来实现与您的服务器进行 MQTT 通信。本教程将会引导您如何使用这个包,从安装到实现通信,让您能够快速地将它应...

    3 年前
  • npm 包 ng-pell 使用教程

    在前端开发中,富文本编辑器是一个非常常见的功能。今天,我要介绍一个 npm 包 ng-pell,它是一个基于 Angular 的富文本编辑器,使用简单方便,且定制化能力也非常强。

    3 年前
  • npm包grafana-dsl使用教程

    前言 Grafana是一个开源的度量分析与可视化平台,用于监视数据和分析数据。而grafana-dsl是一个npm包,它提供了一种使用JavaScript来生成grafana面板和指标的方法。

    3 年前
  • NPM包 next-stub 使用教程 #

    前言:在编写前端代码时,如果需要调用一个尚未开发完成的模块,可能会碰到一些问题。这时候,我们需要一个快速解决的方案,next-stub 能够帮我们解决这个问题。接下来,本文将介绍如何使用 next-s...

    3 年前
  • npm 包 gxy 使用教程

    介绍 npm 包 gxy 提供了一套前端开发架构,包括了模块化开发、自动化构建、前端性能优化等方面的解决方案。在前端开发中使用 gxy 可以提高代码质量、开发效率和代码可维护性。

    3 年前
  • npm包 hxy 的使用教程

    在前端开发中,使用npm包可以极大地提高代码的复用性和可维护性。其中,hxy是一款十分优秀的npm包。本文将为大家介绍hxy的使用教程及其深层次应用和指导意义。 什么是 hxy? hxy是一个npm包...

    3 年前
  • npm 包 rocket-sass 使用教程

    本文主要介绍前端工程化中使用的一种工具 -- npm 包 rocket-sass。 什么是 rocket-sass rocket-sass 是 sass 语法的高级封装,可以让我们在前端项目中更高...

    3 年前
  • npm 包 uxy 使用教程

    前言 在前端开发中,我们经常会使用各种开源的 npm 包来简化自己的工作,提高代码质量和开发效率。而 uxy 就是一个非常实用的 npm 包,它可以让我们在前端开发中更加方便地实现用户体验优化的功能,...

    3 年前
  • npm 包 one-calculator 使用教程

    简介 one-calculator 是一个基于 JavaScript 的 npm 包,该包封装了常见的计算功能,包括加减乘除、取余、幂运算、阶乘、自然对数等。该包适用于前端开发,可用于 web 应用开...

    3 年前
  • npm 包 printable-characters-plus-directional 使用教程

    介绍 在前端开发中,由于涉及到多语言和不同的文本方向,常常需要处理字符的显示问题。由于不同语言对字符编码的要求不一样,可能会导致一些特殊字符无法正常显示或出现奇怪的乱码。

    3 年前
  • npm 包 mtae-group-app-components 使用教程

    简介 mtae-group-app-components 是一款针对移动端的 UI 库,提供了许多常用的组件,如按钮、表单、列表等。它基于 React 框架开发,可以帮助开发者快速搭建移动应用,提高开...

    3 年前
  • npm包 `angular-material-persian-datepicker`使用教程

    前言 在前端开发中,日期选择器是非常常见的一个组件。而使用 angular-material-persian-datepicker 这个npm包,可以快速集成实现一个支持波斯语日期的日期选择器。

    3 年前
  • npm 包 hubot-hyper 使用教程

    近年来,随着人工智能技术的不断发展,聊天机器人受到了越来越多的关注。使用聊天机器人可以帮助我们快速地与用户进行交互和沟通。而其中一款使用最为广泛的聊天机器人框架就是 hubot,它可以用来创建自定义的...

    3 年前
  • npm 包 localforage-node-json 使用教程

    在前端开发中,有时需要将数据存储在本地,同时需要通过 JavaScript 进行 CRUD 操作。本文介绍一个方便的 npm 包 localforage-node-json,它提供了一个简单易用的封装...

    3 年前
  • npm 包 recall-point 使用教程

    npm 包 recall-point 使用教程 前言 在现代 Web 开发中,使用 npm 这个包管理工具已经是家常便饭了。而 recall-point 是一个适用于前端的记忆点检索库,可以快速的根据...

    3 年前
  • npm 包 formsy-react-patched 使用教程

    前端开发中,表单验证是一个必不可少的功能。而 formsy-react-patched 就是一个常用的表单验证库。这个库基于 formsy-react 开发,但相比于原版,它具有更高的可扩展性和更丰富...

    3 年前
  • npm包 metalsmith-podcast 使用教程

    随着播客的流行,越来越多的人开始创建自己的播客。如果你已经有一些音频文件并且希望将它们转换为播客,那么npm包 metalsmith-podcast可以帮助你实现这一目标。

    3 年前
  • npm 包 mod-floor-ceiling 使用教程

    背景 在前端开发中,我们常常需要处理数字的取整操作,例如对于一个小数 x,我们需要对其进行向下取整、向上取整或四舍五入等操作。JavaScript 语言本身提供了相应的函数 Math.floor、Ma...

    3 年前

相关推荐

    暂无文章