Smartour——让网页导览变得更简单

SHERlocked93 发布于2019-08-23 18:27 / 3369人阅读

摘要：比较常规的办法是添加一个蒙层，高亮显示被调整的区域，然后通过文字介绍去完成引导。基本用法提供了一个非常简单的这是高亮一个元素最简单的方式。插槽插槽是用于为高亮元素提供描述的字符串。

在遇到网页内容有着较大调整的时候，往往需要一个导览功能去告诉用户，某某功能已经调整到另外一个位置。比较常规的办法是添加一个蒙层，高亮显示被调整的区域，然后通过文字介绍去完成引导。我们把这个功能称为“导览”，而 Smartour 则把这个导览的功能抽离出来，提供了一个开箱即用的解决方案。

项目地址：https://github.com/jrainlau/s...
官方示例：https://jrainlau.github.io/sm...

Install

Smartour 被构建成了 umd 和 es module 模块，允许用户通过不同的方式引入。

npm install smartour

/* ES Modules */
import Smartour from "smartour/dist/index.esm.js"
/* CommandJS */
const Smartour = require("smartour")
/*

基本用法

Smartour 提供了一个非常简单的 API focus(), 这是高亮一个元素最简单的方式。

let tour = new Smartour()

tour.focus({
  el: "#basic-usage"
})

插槽 Slot

插槽 slot 是用于为高亮元素提供描述的 html 字符串。

纯字符串:

let tour = new Smartour()

tour.focus({
  el: "#pure-string",
  slot: "This is a pure string"
})

Html 字符串

let tour = new Smartour()

tour.focus({
  el: "#html-string",
  slot: `
    
      This is a html string
    
  `
})

插槽位置

插槽的位置可以选择4个不同的方向: top, right, left, bottom.

设置 options.slotPosition 属性即可覆盖默认的 top 位置。

let tour = new Smartour()

tour.focus({
  el: "#slot-positions",
  slot: `top`,
  options: {
    slotPosition: "top" // 默认为 `top`
  }
})

插槽事件

插槽所定义的元素也可以绑定事件。我们通过 keyNodes 属性来为插槽元素绑定事件。

keyNodes 是内容为一系列 keyNode 的数组。属性 keyNode.el 是一个 css 选择器，而 keyNode.event 属性则是对应元素所绑定的事件。

let tour = new Smartour()

tour.focus({
  el: ".slot-events-demo",
  options: {
    slotPosition: "right"
  },
  slot: `

      Click here to occur an alert event
    

      Click here to occur an alert event
    
  `,
  keyNodes: [{
    el: ".occur-1",
    event: () => { alert("Event!!") }
  }, {
    el: ".occur-2",
    event: () => { alert("Another event!!") }
  }]
})

Queue

有的时候页面需要不止一个导览。Smartour 允许你把一系列的导览通过 .queue() 放在一起，然后挨个挨个地展示它们。

举个例子:

let tour = new Smartour()

tour
  .queue([{
    el: ".li-1",
    options: {
      layerEvent: tour.next.bind(tour)
    },
    slot: "This is the 1st line."
  }, {
    el: ".li-2",
    options: {
      layerEvent: tour.next.bind(tour)
    },
    slot: "This is the 2nd line."
  }, {
    el: ".li-3",
    options: {
      layerEvent: tour.next.bind(tour)
    },
    slot: "This is the 3rd line."
  }])
  .run() // 别忘了调用 `run()` 方法去展示第一个导览

选项

Smartour 是一个构建函数，它接收一个 options 参数去覆盖其默认选项

让我们看看它的默认选项是什么样子的：

{
  prefix: "smartour", // class 前缀
  padding: 5, // 高亮区域内边距
  maskColor: "rgba(0, 0, 0, .5)", // 带透明值的遮罩层颜色
  animate: true, // 是否使用动画
  slotPosition: "top" // 默认的插槽位置
  layerEvent: smartour.over // 遮罩层点击事件，默认为结束导览
}

APIs

除了 .focus()，.queue() 和 .run() API 以外，Smartour 还提供了另外三个 API 专门用于控制导览的展示。

.next()：展示下一个导览（只能配合 .queue() 使用）。

.prev()：展示上一个导览（只能配合 .queue() 使用）。

.over()：结束全部导览。

Smartour 的原理

Smartour 通过 element.getBoundingClientRect() api 来获取目标元素的宽高和位置信息，然后放置一个带着 box-shadow 样式的元素在其之上作为高亮区域。

由于点击事件无法再 box-shadow 的区域里触发，所以 Smartour 还放置了一个全屏透明的遮罩层用于绑定 layerEvent 事件。

高亮区域和插槽都被设置为 absolute。当页面滚动时，document.documentElement.scrollTop 或者 document.documentElement.scrollLeft 的值就会变化，然后 Smartour 会实时修正它的位置信息。

证书

MIT

云服务器 GPU云服务器如何让服务器更安全、 Smartour 简单网页网页制作简单

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/105246.html

ReactJS新闻 #20 React Conf 2017主题演讲

摘要：新闻第期新闻主题演讲与分别负责开场的部份，首先对自年来的发展情况讲演，以及近年来的成长趋势。会议视频网址官网以卡通图画介绍是即将上市的新核心，也是本次的重点发表技术之一，用了卡通画方式，来解说的设计与改进之处。 ReactJS新闻第020期 (2017.03.19) 新闻 React Conf 2017主题演讲 Tom、Jing与Sebastian分别负责开场的keynote部份，...

pkhope 2019-08-20 15:14 评论0 收藏0
前端插件库

摘要：原文链接前端插件库站点前端开发文档博客前端插件库前端插件库官网是的函数库，目的是强化表格操作如搜索排序，并自动加入组件引入表格中，使用非常灵活简便。由推出，灵活扎实的建议列表函数库。原文链接：前端插件库站点：前端开发文档博客：前端插件库前端插件库 DataTables 官网：https://www.datatables.net/ DataTables是jQuery的JavaScr...

高胜山 2019-08-26 13:44 评论0 收藏0
前端插件库

摘要：原文链接前端插件库站点前端开发文档博客前端插件库前端插件库官网是的函数库，目的是强化表格操作如搜索排序，并自动加入组件引入表格中，使用非常灵活简便。由推出，灵活扎实的建议列表函数库。原文链接：前端插件库站点：前端开发文档博客：前端插件库前端插件库 DataTables 官网：https://www.datatables.net/ DataTables是jQuery的JavaScr...

shusen 2019-08-30 10:53 评论0 收藏0
三里屯、秦淮河、故宫，是什么让它们走在了一起

摘要：三里屯秦淮河故宫，是什么让它们走在了一起物联网对于很多人来说是一个既熟悉又陌生的领域，之所以说熟悉是因为物联网一词在过去十几年间一直被热炒，国家也将物联网上升为战略发展高度。三里屯、秦淮河、故宫，是什么让它们走在了一起物联网对于很多人来说是一个既熟悉又陌生的领域，之所以说熟悉是因为物联网一词在过去十几年间一直被热炒，国家也将物联网上升为战略发展高度。但大多数人对物联网的印象却又是模糊...

vslam 2019-08-20 17:38 评论0 收藏0
三里屯、秦淮河、故宫，是什么让它们走在了一起

摘要：三里屯秦淮河故宫，是什么让它们走在了一起物联网对于很多人来说是一个既熟悉又陌生的领域，之所以说熟悉是因为物联网一词在过去十几年间一直被热炒，国家也将物联网上升为战略发展高度。三里屯、秦淮河、故宫，是什么让它们走在了一起物联网对于很多人来说是一个既熟悉又陌生的领域，之所以说熟悉是因为物联网一词在过去十几年间一直被热炒，国家也将物联网上升为战略发展高度。但大多数人对物联网的印象却又是模糊...

stdying 2019-06-28 10:52 评论0 收藏0