npm 包 react-popper-tooltip 使用教程

阅读时长 7 分钟读完

前言

在前端开发中,我们常常需要自定义工具提示元素。react-popper-tooltip 是一个基于 popper.js 和 React 的轻量级包,可以让你在应用程序中快速创建丰富的提示工具。

在本文中,我们将介绍如何使用 react-popper-tooltip,从安装开始,然后演示如何创建自定义提示工具元素,最后是高级主题。

安装

react-popper-tooltip 可以通过 npm 安装。在终端中,输入以下命令:

基本用法

引入

为了使用 react-popper-tooltip,首先需要导入所需的模块:

基本结构

使用 react-popper-tooltip 创建自定义工具提示非常简单。只需要向 Tooltip 组件传递一个触发元素以及一个提示内容元素。

tooltip 属性是要显示的内容,并且可以是任何可以呈现的 React 元素。trigger 属性是触发工具提示的 React 元素。注意,trigger 属性必须是可包含在 div 中的元素或组件。

方向和位置

默认情况下,工具提示位于触发元素的底部中心。但是如果需要,还可以指定工具提示的方向和位置。

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

在上面的例子中,placement 属性设置为 "top-start",这将使工具提示出现在触发元素的顶部。还添加了一个 modifiers 属性,其中包含一个偏移调整,以便工具提示与触发元素之间有间距。

定制工具提示

react-popper-tooltip 提供了许多选项来定制工具提示。例如,可以在工具提示周围添加填充、更改工具提示的样式以及添加其他元素等。

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

在上面的例子中,tooltip 属性是一个函数,它返回一个带有自定义内容的 div 元素。还向 modifiers 添加了一个选项,以确保工具提示不会超出窗口边界。

高级主题

动态触发

如果需要在动态元素上显示工具提示,则可以使用 useTooltipTrigger 自定义 hook。这个 hook 使你可以动态设置触发元素。

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

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

在上面的例子中,useTooltipTrigger hook 返回一个包含三个元素的数组。第一个元素是绑定到触发元素的 ref,第二个元素是工具提示的 "打开" 状态,第三个元素是设置 "打开" 状态的函数。

内容自定义渲染

如果需要对工具提示的内容进行更多的自定义,则可以使用 useTooltip 自定义 hook。

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

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

在上面的例子中,useTooltip hook 返回一个包含许多有用方法的对象,例如 getTooltipPropsgetArrowProps,这些方法将触发元素的属性与工具提示内容关联起来。你还可以检索当前工具提示的可见性,并在内容中进行响应。

结论

在 react-popper-tooltip 方便的 API 的帮助下,我们可以创建出漂亮而易用的工具提示,以提高用户体验并增强用户操作的效率。

在本教程中,我们学习了如何使用 react-popper-tooltip,从简单的起步到复杂的具有高级主题,也有了了解。如果你是 Web 开发人员,并且还没有尝试过 react-popper-tooltip,那么建议赶紧开始尝试吧。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/the-react-in-popper-tooltip