npm 包 @evansjohnson/react-joyride 使用教程

介绍

@evansjohnson/react-joyride 是一个基于 React 的轻量级应用程序导航库,用于在您的应用程序中添加一个自动化的产品演示。它是一种简单的方法来为用户提供对您的应用程序的导览,鼓励他们探索您的产品,了解您的特点,以及减轻用户的学习曲线。本文章将为你提供使用 @evansjohnson/react-joyride 的完整教程。

安装

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

使用方法

首先,导入所需的组件和样式:

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

然后,在你的组件中添加 Joyride 组件,设置需要显示的步骤:

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

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

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

现在,只需在需要显示 Tour 的事件(例如按钮的点击事件)中激活 Tour:

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

就可以运行整个 Tour 了。

属性

以下是 Joyride 可以接受的所有属性:

steps

(必选) : 数组,包含所有的 Tour 步骤。

run

默认:false,tour 开始后会变为 true。

continuous

默认:false,当完成了整个 Tour 时是否重新开始。

disableOverlayClose

默认:false,可以通过点击引导遮罩层外的其他元素来关闭 Tour。如果设置为 true,则不允许关闭 Tour。

disableOverlay

默认:false,指示是否应该应用引导遮罩层。如果设置为 true,则不显示遮罩层。

disableCloseButton

默认:false,在引导过程中是否显示关闭按钮。

disableScrolling

默认:false,当 Tour 正在运行时,是否允许滚动。

showProgress

默认:false,是否显示进度条。

showSkipButton

默认:false,是否显示跳过按钮。

showBackButton

默认:false,是否显示后退按钮。

showOverlay

默认:true,是否显示遮罩层。

spotlightClicks

默认:false,是否将用户单击限制在区域内。

spotlightPadding

默认: 10,遮罩层填充大小。

styles

包含所有可自定义的样式。

事件

以下是 Joyride 发出的所有事件:

callback

默认:()=>{},在 Tour 过程中返回每一个步骤的 status 和 type。

complete

在 Tour 完成时触发的事件。

error

当有错误发生时触发的事件。

close

关闭 Tour 时触发的事件。

示例代码

以下是一个完整的使用示例:

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

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

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

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

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

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

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

总结

通过 @evansjohnson/react-joyride,我们可以为我们的产品提供一个简单的,自动化的产品演示,减少用户的学习曲线,让他们更快地熟悉我们的应用程序。通过本文,你已经学会了如何在 React 中使用 @evansjohnson/react-joyride,希望这篇文章能够给你带来指导和启发。

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


猜你喜欢

  • npm 包 @souct/countdown 使用教程

    简介 倒计时(countdown)在前端开发中应用非常广泛,例如秒杀、抢购、倒计时活动等等。@souct/countdown 是一款基于 JavaScript 打造的倒计时组件,可以快速实现倒计时功能...

    3 年前
  • npm 包 deeply-freeze 使用教程

    在前端开发中,经常会遇到需要对 JavaScript 对象进行深度冻结(Deep Freeze)的情况。JavaScript 对象的深度冻结可以保护对象的数据完整性,防止对象被修改。

    3 年前
  • npm 包 eslint-config-wslfx 使用教程

    在前端开发中,保持代码质量和可读性非常重要。其中一个实现方式是使用 ESLint 来检查和规范 JavaScript 代码。而使用一个公共的 ESLint 配置可以让团队在开发过程中保持一致性。

    3 年前
  • npm 包 find-newer-docker-image 使用教程

    前言 随着 Docker 技术的流行,越来越多的企业开始使用 Docker 部署他们的应用程序。但是,在使用 Docker 部署应用程序的过程中,我们经常需要查找新的 Docker 镜像,并且需要把镜...

    3 年前
  • npm包remisa使用教程

    在前端开发中,我们经常需要使用一些实用的工具来帮助我们提高开发效率。其中,npm 包remisa就是一个非常实用的工具,它可以帮助我们轻松地实现响应式设计。本文将介绍npm包remisa的使用方法,帮...

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

    前言 Arisen 是一个全球性的区块链应用,ArisenJS-API 是 Arisen 区块链 JavaScript 库中的一个 API,它可以让前端开发人员通过 JavaScript 与 Aris...

    3 年前
  • npm包mab-graphql-query-assembler使用教程

    前言 在开发现代web应用的过程中,GraphQL成为了越来越流行的API查询语言。然而,手动创建GraphQL查询往往需要编写大量的文本,并且容易出错。现在有许多npm包能够帮助我们生成GraphQ...

    3 年前
  • npm 包 haidict 使用教程

    简介 haidict 是一个基于 Node.js 的英汉双解词典,提供了中英文单词的查询、翻译和发音等功能,适用于前端和后端工程师开发英语学习相关的应用程序。 安装 在 Node.js 的命令行窗口中...

    3 年前
  • npm 包 common-data-utils 使用教程

    在前端开发中,我们经常会涉及到处理数据的操作,比如格式化日期、计算数组元素之和等常见的操作。为了提高代码的可复用性,我们可以使用 npm 包来帮助我们处理这些常见的数据操作。

    3 年前
  • npm 包 dg-form-validator 使用教程

    简介 dg-form-validator 是一款针对前端表单数据校验的 npm 包,支持常见数据类型的校验和自定义校验规则。在前端项目中,表单数据校验是常见需求,dg-form-validator 可...

    3 年前
  • npm 包 pedograph 使用教程

    什么是 pedograph Pedograph 是一款基于 D3.js 构建的 JavaScript 库,可以用来创建各种类型的网络图形。它非常适合用于可视化大型复杂的关系网络数据。

    3 年前
  • npm 包 framerate-optimizer 使用教程

    在前端开发中,动画效果的流畅度是一个很重要的指标。如果动画效果不流畅,会影响用户体验。而 framerate-optimizer 就是一个可以优化动画帧率的 npm 包。

    3 年前
  • npm 包 actions-tools 使用教程

    什么是 actions-tools actions-tools 是一个 npm 包,提供了一系列精简、高效的命令行工具,方便开发者在 GitHub Actions 中使用。

    3 年前
  • npm 包 irkfdb-node-client 使用教程

    irkfdb-node-client 是一个基于 Node.js 的 npm 包,它提供了与 irkfdb.com 交互的 Node.js API。irkfdb.com 是一个提供翻译和注释 Java...

    3 年前
  • npm 包 freeman.gdpr.piicookieconsent 使用教程

    简介 在网站或应用中,如果需要收集用户的个人信息,需要遵循 GDPR 等相关条例,应该要在页面上提示用户并征得其同意。在这种情况下,可以使用 freeman.gdpr.piicookieconsent...

    3 年前
  • npm包freeman.gdpr.privacycookieconsent使用教程

    在网站开发中,满足用户隐私保护需求是十分重要的。为了更加便捷地实现这一需求,我们可以通过npm包安装freeman.gdpr.privacycookieconsent来实现。

    3 年前
  • npm 包 node-red-contrib-convert 使用教程

    node-red-contrib-convert 是一个方便的 npm 包,它可以帮助前端开发人员快速地进行各种数据格式之间的转换。本篇文章将为大家详细介绍如何使用这个 npm 包。

    3 年前
  • npm 包 @agilatech/lynxari-timer-application 使用教程

    介绍 @agilatech/lynxari-timer-application 是一个基于 Node.js 的 npm 包,用于进行 Lynxari 系统的计时应用程序开发。

    3 年前
  • npm 包 jaybe78-babel-changed 使用教程

    在前端开发中,我们经常需要将 ES6 代码转换成 ES5 代码,以兼容更多的浏览器和环境。而 babel 是最常用的工具之一。我们可以自己配置 babel,使用 babel-cli 进行转换,也可以使...

    3 年前
  • npm 包 justows.conn.log.zeromq 使用教程

    简介 npm包 justows.conn.log.zeromq是一款用于Node.js平台的工具,用于将日志数据发送到ZeroMQ消息队列的工具。使用该工具,用户可以将日志数据发送到任何使用ZeroM...

    3 年前

相关推荐

    暂无文章