npm 包 Shepherd 使用教程

Shepherd 是一个开源的 JavaScript 库,提供了一种易于使用但功能强大的方式来创建带有导航和浮动提示的交互式向导。本文将详细介绍如何使用 Shepherd。

安装与引入

首先,在项目中安装 Shepherd:

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

然后,在需要使用 Shepherd 的页面中引入它:

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

创建步骤

Shepherd 将向导看作是由多个步骤组成的过程。下面展示了创建一个简单的向导步骤的代码:

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

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

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

这段代码创建了一个名为 tour 的新向导,其中包含一个名为 Step 1 的步骤。该步骤显示了一条消息,并在 .example-element 元素的下方显示了一个箭头。此外,它显示了两个按钮:一个标有“下一步”文本的主要按钮,以及一个标有“取消”文本的辅助按钮。

更多选项

除了上面的 attachTotitletext 选项外,Shepherd 还提供了许多其他选项,以帮助您自定义向导的外观和行为。以下是其中一些选项:

  • classes:为步骤添加自定义 CSS 类。
  • beforeShowPromise:在显示步骤之前运行的回调函数。
  • showCancelLink:控制是否显示“取消”链接。
  • when:定义何时应该跳转到下一个步骤。

使用事件

Shepherd 还提供了多个事件,可用于在向导生命周期中执行自定义操作。例如,以下代码演示了如何在向导结束时弹出一个消息框:

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

以下是 Shepherd 的其他事件:

  • cancel
  • hide
  • inactive
  • show
  • start

结论

本文详细介绍了 Shepherd 如何使用。尽管 Shepherd 简单易用,但它提供了丰富的功能和选项,使您能够创建高度定制化的交互式向导。希望这篇文章对读者有所帮助,可以更好地利用 Shepherd 来实现自己的项目需求。

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


猜你喜欢

  • npm 包 vex-js 使用教程

    什么是 vex-js? vex-js 是一款基于 JavaScript 的轻量级弹窗插件。它可以帮助前端开发人员快速地在网站中添加弹窗,以提供更好的用户体验。 安装 vex-js 你可以通过 npm ...

    6 年前
  • npm 包 limonte-sweetalert2 使用教程

    简介 limonte-sweetalert2 是一款强大的 JavaScript 弹窗插件,可以用于显示各种类型的提示框、警告框、错误框等。它支持自定义样式、动画和按钮等,并且易于使用和集成。

    6 年前
  • npm 包 markdown.js 使用教程

    在前端开发中,Markdown 是一种非常流行的文本格式,它可以用来快速的写出格式清晰、易于阅读的文档。而使用 Markdown.js 这个 npm 包,可以方便地将 Markdown 文本转换成 H...

    6 年前
  • npm 包 swipe 使用教程

    在前端开发中,轮播图是一个非常常见的功能。然而,每次都从头开始写轮播图代码显然是一件非常繁琐的事情。而 swipe 就是一个非常好用的 npm 包,可以帮助我们快速实现轮播图。

    6 年前
  • npm 包 wysihtml5 使用教程

    在前端开发中,富文本编辑器是一个非常重要的工具。wysihtml5是一款基于HTML5的富文本编辑器,它支持多种浏览器,并且易于使用和集成到你的项目中。 安装 你可以通过npm来安装wysihtml5...

    6 年前
  • npm 包 flight 使用教程

    介绍 flight 是一个基于 jQuery 的轻量级前端框架,它提供了一种模块化的方式来组织代码,使得开发者能够更好地管理和维护前端应用程序。在本文中,我们将介绍如何使用 npm 安装和使用 fli...

    6 年前
  • npm 包 morris.js 使用教程

    简介 morris.js 是一个简单易用、轻量级的 JavaScript 图表库,提供多种图表类型,如线图、柱状图、区域图等,并支持自适应布局和动画效果。它可以通过 npm 包来安装和使用。

    6 年前
  • npm包foundation-emails使用教程

    简介 Foundation Emails是一个开源的、响应式的电子邮件模板集合,可用于构建跨平台的电子邮件。该项目通过npm包进行分发和管理。 在本文中,我们将学习如何安装、配置和使用Foundati...

    6 年前
  • npm 包 semantic-ui-react 使用教程

    Semantic UI React 是一个基于 React 的 UI 组件库,它提供了一系列易于使用、高度可定制的组件,能够帮助前端开发人员快速构建出漂亮、具有交互性的用户界面。

    6 年前
  • NPM 包 EaselJS 使用教程

    EaselJS 是一款基于 HTML5 Canvas 的开源画布库,它提供了一系列的 API 和工具,使得在 Web 上创建交互式的图形和动画变得更加容易。本文将详细介绍如何使用 NPM 包管理器来安...

    6 年前
  • npm 包 libphonenumber 使用教程

    简介 libphonenumber 是一个由 Google 开发的 JavaScript 库,用于处理和验证国际电话号码。它可以将输入的电话号码转换为国际标准格式,并提供了验证、解析和格式化函数。

    6 年前
  • npm 包 Cropper 使用教程

    简介 Cropper 是一个基于 JavaScript 的图片裁剪库,通过该库我们可以在前端实现对图片进行裁剪、旋转等操作。本文将详细介绍如何使用 npm 包 Cropper 进行图片裁剪。

    6 年前
  • npm 包 dynamics.js 使用教程

    简介 dynamics.js 是一款用于制作动态交互效果的 JavaScript 库,它支持许多不同类型的运动和缓动效果,并且使用起来简单易上手。在本教程中,我们将介绍如何使用 npm 包来安装并使用...

    6 年前
  • npm 包 `metrics-graphics` 使用教程

    metrics-graphics 是一个基于 D3.js 的 JavaScript 库,用于创建交互式的、响应式的图表和可视化。本文将介绍如何使用 npm 包安装和使用 metrics-graphic...

    6 年前
  • npm 包 muuri 使用教程

    什么是 muuri muuri 是一个基于 JavaScript 的响应式、可排序和过滤的网格布局库。它支持拖放和动画效果,并且能够自适应不同大小的屏幕。在前端开发中,muuri 可以用来创建美观、交...

    6 年前
  • npm 包 matter-js 使用教程

    Matter.js 是一个可用于创建 2D 物理引擎的 JavaScript 库。它是一个非常强大的库,可以用于实现各种前端效果,例如动画、游戏等。本文将介绍如何使用 npm 包 matter-js,...

    6 年前
  • npm包gmaps.js使用教程

    介绍 gmaps.js是一个基于Google Maps API封装的JavaScript库,使得使用Google Maps API变得更加简单。它提供了简单易用的API来创建地图、添加标记、定位和路线...

    6 年前
  • 使用 tachyons npm 包打造高效前端界面

    介绍 tachyons 是一个基于 CSS 的工具包,可以帮助开发者快速构建现代化的前端界面。相比于传统的 CSS 框架(如 Bootstrap 和 Foundation),tachyons 更加轻量...

    6 年前
  • npm 包 Primer 使用教程

    介绍 Primer 是一款功能强大的前端 JavaScript 库,可以帮助开发者快速构建 Web 应用程序和用户界面。它提供了许多可重用组件和工具,使得构建复杂的应用程序变得更加简单。

    6 年前
  • npm 包 Interact.js 使用教程

    Interact.js 是一款强大的 JavaScript 库,用于实现拖放、缩放和旋转等交互效果。它提供了丰富的功能和事件来处理各种用户交互操作。在本文中,我们将探讨 Interact.js 的使用...

    6 年前

相关推荐

    暂无文章