https://github.com/growingio/growingio-sdk-webjs-autotracker

GrowngIO官方 WebJS SDK，具备自动采集基本的用户行为事件，比如访问和行为数据等。目前支持代码埋点、无埋点等功能。
https://github.com/growingio/growingio-sdk-webjs-autotracker

Last synced: about 1 month ago
JSON representation

GrowngIO官方 WebJS SDK，具备自动采集基本的用户行为事件，比如访问和行为数据等。目前支持代码埋点、无埋点等功能。

• Host: GitHub
• URL: https://github.com/growingio/growingio-sdk-webjs-autotracker
• Owner: growingio
• License: gpl-3.0
• Created: 2022-06-24T09:30:59.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-15T02:36:27.000Z (8 months ago)
• Last Synced: 2024-04-16T05:12:55.092Z (8 months ago)
• Language: TypeScript
• Homepage: https://growingio.github.io/growingio-sdk-docs/docs/webjs
• Size: 886 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
GrowingIO WebJS SDK (GrowingIO WebJS Autotracker)

======

![GrowingIO](https://www.growingio.com/vassets/images/home_v3/gio-logo-primary.svg)

# Web/H5/小程序内嵌页/Hybrid数据采集 SDK

## 介绍

- 无埋点能力，自动采集用户行为事件，可通过开关和插件控制。

- 埋点能力，开发同学可调用 Api 主动采集自定义事件。

- 支持半自动曝光事件。

- 可依据使用场景自由拆分 SDK，减少大小。

- 支持自定义插件开发。

## 官方集成文档（Integration Document）

[集成文档](https://growingio.github.io/growingio-sdk-docs/docs/webjs)

## 开发

### 检查环境

Nodejs 版本>=14，推荐使用 Nodejs v16。（推荐使用 nvm 进行 Nodejs 版本管理）

### 安装依赖包

> npm install

### 开发

单独开发SDK

> npm run dev

单独开发插件

> npm run dev:plugins

### 打包

打包SDK和插件

默认打包umd格式

> npm run build

指定打包esm格式

> npm run bnuild:es

单独打包SDK

默认打包umd格式

> npm run build:sdk

指定打包esm格式

> npm run bnuild:sdk-es

单独打包插件

默认打包umd格式

> npm run build:plugins

指定打包esm格式

> npm run build:plugins-es

## 浏览器兼容性

| [](http://godban.github.io/browsers-support-badges/)
IE / Edge | [](http://godban.github.io/browsers-support-badges/)
Firefox | [](http://godban.github.io/browsers-support-badges/)
Chrome | [](http://godban.github.io/browsers-support-badges/)
Safari | [](http://godban.github.io/browsers-support-badges/)
Opera |[](http://godban.github.io/browsers-support-badges/)
Electron |

| --------- | --------- | --------- | --------- | --------- | --------- |

| IE11 / Edge > 15 major / Edge IE兼容模式| > 54 major | > 51 major | > 10 major | > 38 major | > 10 major |

## 开发插件

- 这里提供一个Demo供参考：

```js

/**

 * 名称：插件Demo

 * 用途：用于提供编写插件的模板。

 */

import { GrowingIOType } from '@/types/growingIO';

class GioDemoPlugin {

  constructor(public growingIO: GrowingIOType) {

    const { emitter } = this.growingIO;

    emitter.on('SDK_INITIALIZED', (args) => { ...});

    // 其他可支持监听的消息名称请参考 src -> constants -> emitMsg.ts

  }

  onInstall(args) {

    // console.log('onInstall', args);

  }

  onError(args) {

    // console.log('onError', args);

  }

  onComposeBefore(args) {

    // console.log('onComposeBefore', args);

  }

  onComposeAfter(args) {

    // console.log('onComposeAfter', args);

  }

  onSendBefore(args) {

    // console.log('onSendBefore', args);

  }

  onSendAfter(args) {

    // console.log('onSendAfter', args);

  }

}

export default { name: 'gioDemoPlugin', method: GioDemoPlugin };

```

## 开源说明

开源的源代码移除了性能监控、第三方厂商适配以及定制化开发的一些商业化内容，和自动化测试的相关代码。仅保留相对完整的SDK主要内容。

GrowingIO WebJS SDK 完全免费并开源，请注意仔细甄别。欢迎大家一起学习进步和互相帮助。

Tips：请注意开源协议。