@magnet-fe/magnet-data-tracker
TypeScript icon, indicating that this package has built-in type declarations

0.0.3 • Public • Published

磁场数据统计组件

已对接统计

  • [x] 神策sensors
  • [x] 腾讯MTA

使用方法

npm install @magnet-fe/magnet-data-tracker

// main.jsx or main.tsx
import MagnetDataTracker from '@magnet-fe/magnet-data-tracker'
import { MtaTracker, SensorsTracker } from '@magnet-fe/magnet-data-tracker'

MtaTracker.init({
  mtaConfig?: IMtaConfig; // mta配置项
  routerEvents?: Map<RegExp, string>;
  needAutoPageViewTrack?: boolean; // 开启自动统计页面浏览: 通过mockey patch history.pushstate 以及 history.replaceState事件,发送页面浏览事件
})

SensorsTracker.init({
  sensorsConfig?: ISensorsConfig; // 神策配置项
  routerEvents?: Map<RegExp, string>;
  needAutoPageViewTrack?: boolean;
})

暴露的公开方法

  • track
MtaTracker.track(eventName: string, options?: IKeyValue)
SensorsTracker.track(eventName: string, options?: IKeyValue)

关于自动埋点事件

  • 页面接受点击事件,在事件捕捉过程会检查点击元素的dataset,如果存在约定的名称将自动发送事件
    • element.dataset.tracker-event-name: 事件名称
    • element.dataset.tracker-event-options: 事件参数JSON string
  • 例子
    • <button data-tracker-event-name='submitForm' data-tracker-event-options='{"name":"Heylon","score":100}'>submit</button>

暴露出的第三方客户端

  • Mta: MtaTracker.originalTracker
  • 神策: SensorsTracker.originalTracker

Readme

Keywords

none

Package Sidebar

Install

npm i @magnet-fe/magnet-data-tracker

Weekly Downloads

2

Version

0.0.3

License

ISC

Unpacked Size

22.9 kB

Total Files

22

Last publish

Collaborators

  • handylee
  • ysh_no1
  • jasonheylon