npm 包 rm-react-popover 使用教程

阅读时长 6 分钟读完

简介

rm-react-popover 是一个 React 实现强大的 popover 组件,可以轻松实现鼠标悬停或点击操作后展示一个卡片(常用于显示提示信息)。它易于使用且高度可定制。

安装

要使用 rm-react-popover,你首先需要安装它。你可以使用以下命令:

或者,如果你使用 yarn:

快速入门

让我们快速了解如何在 React 项目中使用 rm-react-popover。

首先,导入 rm-react-popover 模块:

然后,在渲染方法中创建一个 Popover:

这将创建一个展示 '示例文本' 的 popover,该卡片将在渲染 target 属性中的按钮时显示。

现在,你已经创建了一个可开箱即用的 popover 组件。当然,除此之外,rm-react-popover 还有很多高级的特性和选项,让我们接下来深入了解。

API 文档

Required Props

  • target – popover 显示的 DOM 元素或 React 组件(必填)
  • content – popover 内容(必填)

Optional Props

  • align – popover 如何定位(默认为 'top')
  • gap – 离目标元素的距离(单位为像素,默认为 10)
  • zIndex – popover 的 z-index(默认为 1)
  • onOuterAction – 点击页面覆盖部分时执行的额外回调事件
  • shouldCloseOnOuterAction – 在点击页面覆盖部分时是否应该关闭 popover(默认为 true)
  • appearDelay – popover 出现的延迟毫秒数
  • enterDelay – popover 鼠标悬停进入元素的延迟毫秒数
  • leaveDelay – popover 鼠标悬停离开元素的延迟毫秒数
  • useHover – 是否应该使用悬停而不是点击来触发 popover(默认为 false)
  • trigger – popover 何时出现(默认为 'click'。其他选项包括 'right-click','double-click','hover')

详细说明

  • align 可以为 'top','bottom','left' 或 'right',表示 popover 的出现位置相对于 target,默认是 'top';
  • gap 表示 popover 与 target 之间的像素距离,默认是 10;
  • zIndex 表示 popover 的 z-index 属性,默认是 1,可以自定义;
  • onOuterAction 表示当点击页面其他区域时会触发的回调函数;
  • shouldCloseOnOuterAction 表示当点击页面其他区域时 popover 是否自动关闭;
  • appearDelay 表示 popover 的出现延迟,单位是毫秒;
  • enterDelay 表示鼠标进入时 popover 的延迟,单位是毫秒;
  • leaveDelay 表示鼠标离开时 popover 的延迟,单位是毫秒;
  • useHover 是一个布尔值,表示 popover 是否应该在悬停时而不是点击时触发;
  • trigger 表示 popover 的触发方式,可选的值有 'click','right-click','double-click' 和 'hover'。

示例

基本用法

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

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

自定义样式

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

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

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

使用悬停而不是点击触发

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

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

在点击其他页面元素时关闭 popover

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

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

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

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

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

结语

rm-react-popover 是一个可定制性强且易于使用的 popover 组件,能够提高前端界面交互的体验效果。希望通过本文的介绍,你能够掌握 rm-react-popover 的基础使用和一些高级特性,加入到你的开发工作中。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056dbb81e8991b448e7165

纠错
反馈