插件集成 (Web)

插件使用方式

目前 Web/小程序 逐步演变为插件化的架构方式。一切都是插件 的概念会越发的明显。

在使用插件前，请务必参考 插件使用方式。

现有插件列表和使用方式

插件根目录为 /dist/web/plugin/，插件所在目录为相对插件根目录的地址。

内置未使用插件

内置未使用的插件，需要手动调用 use 方法，传入插件名称。例如：使用内置未使用的 PageLeave 插件。

import sensors  from '/dist/web/sensorsdata.es6.js';

sensors.use('PageLeave', option);
sensors.init({
	...初始化参数
})

外置插件

外置插件需要手动集成插件，并手动使用。例如：使用外置的 session-event 插件。

import sensors  from '/dist/web/sensorsdata.es6.js';
import sessionEvent  from '/dist/web/plugin/session-event/index.es6.js';

sensors.use(sessionEvent);
sensors.init({
    ...初始化参数
})

内置已使用插件

内置已使用插件为 Web SDK 默认功能（仅供参考）。请勿手动集成和使用！！

第三方插件

以上插件都是神策官方维护的，相对来说比较通用的插件。因为需求越来越多，客户的一些插件是定制型的，不适合神策官方开发，此时我们强烈推荐自己开发第三方插件。

为了提供三方插件的共享，建立了 插件共享仓库，你可以把开发好的代码提交到这里。

如果你有开发第三方插件实现自己定制化需求的意愿，可以通过以下渠道联系我们。目前第三方插件开发处于起步阶段，我们研发会给予足够的支持。

• 在 GitHub issue 讨论
• 联系研发邮箱
• 正式客户微信群中找技术顾问咨询

注意：第三方插件也是外置插件，使用方式与外置插件一致。

注意

• 插件的版本必须和 SDK 一致，只要有一方升级，两边都需要同时更新。切记，不要只更新一侧。
  • 在 v1.24.1 版本后，使用 /dist/web/ 目录，就可以实现同时更新。因为 SDK 和插件都在这个目录，只要引用都指向这里，就可以同时更新。
• 这里的 SDK 版本要求，是拥有当前插件最新功能时，要求的最低 SDK 版本。
• 插件没有自己的版本号，插件有修改，整体版本会增加。
• 如果 GitHub 访问不了的话，也可以下载 npm 在本地目录的 /dist/web/plugin 查看。