npm 包 overtrack.js 使用教程

阅读时长 6 分钟读完

介绍

overtrack.js 是一个轻量级的 JavaScript 库,用于追踪用户鼠标和键盘的行为。它可以用于网站的用户行为分析,也可以用于改善用户体验和提高页面转化率。

本教程将介绍如何在你的项目中使用 overtrack.js,并详细介绍其 API 和配置项,帮助你更好地了解和使用这个工具。

安装

overtrack.js 支持 npm 安装,在命令行中输入以下命令可进行安装:

使用

安装完成后,你需要在你的项目中引入 overtrack.js。你可以在你的 JavaScript 代码中使用 import 或者 require 命令来引入:

API

constructor(options)

overtrack.js 的构造函数接收一个配置对象作为参数,配置项如下:

名称 类型 默认值 说明
click Object null 配置关于鼠标点击事件的行为追踪,包括clickThreshold 点击敏感度、collectTargets 是否收集目标元素等
scroll Object null 配置关于滚动事件的行为追踪,包括 scrollThreshold 滚动敏感度、collectTargets 是否收集目标元素等
mouseMove Object null 配置关于鼠标移动事件的行为追踪,包括 collectTargets 是否收集目标元素等
keyPress Object null 配置关于键盘按键事件的行为追踪,包括 keys 指定哪些按键需要追踪等
start Function null 开始追踪行为的回调函数,会在调用 start() 方法时触发
stop Function null 结束追踪行为的回调函数,会在调用 stop() 方法时触发
interval Number 1000 追踪行为间隔时间,以毫秒为单位
collectStack Boolean false 是否开启调用堆栈信息追踪
collectUrl Boolean false 是否开启页面 URL 信息收集

示例:

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

start()

开始追踪行为。你可以在你的代码中调用此方法启动行为追踪。

stop()

停止追踪行为。你可以在你的代码中调用此方法停止行为追踪。

示例代码

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

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

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

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

以上这段代码会在控制台输出追踪到的行为信息。你可以根据实际情况采取不同的数据上报方式,并基于此进行进一步的数据分析。

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

纠错
反馈