1. Plugin Usage

Currently, Web/Mini Program is gradually evolving into a plugin-based architecture. The concept of "everything is a plugin" will become more apparent.

Before using the plugin, please refer to the Plugin Usage.

2. Existing Plugin List and Usage

The root directory of the plugins is /dist/web/plugin/, and the directory of the plugins is the address relative to the plugin root directory.

2.1. Built-in unused plugins

Built-in unused plugins that need to be manually called with the use method and the plugin name passed in. For example, use the built-in unused PageLeave plugin.

import sensors  from '/dist/web/sensorsdata.es6.js'; sensors.use('PageLeave', option); sensors.init({ 	...初始化参数 }) 

2.2. External Plugin

The external plugin needs to be integrated and used manually. For example, by using the external session-event plugin.

import sensors  from '/dist/web/sensorsdata.es6.js'; import sessionEvent from '/dist/web/plugin/session-event/index.es6.js'; sensors.use(sessionEvent); sensors.init({ 	...初始化参数 }) 

2.3. Built-in Used Plugins

Built-in used plugins are default features of the Web SDK (for reference only). Please do not integrate or use them manually!

2.4.  Third-party Plugin

The above plugins are maintained by Sensors Analytics and are relatively common. However, due to the increasing demand, some plugins customized by clients cannot be developed by Sensors Analytics. At this time, we highly recommend developing third-party plugins.

In order to provide a platform for sharing third-party plugins, we have established the Plugin Sharing Repository. You can submit your developed code here.

If you have the intention to develop third-party plugins to customize your own needs, you can contact us through the following channels. Currently, third-party plugin development is in its early stages, and our research and development team will provide sufficient support.

• In the GitHub issue discussion
• Contact development email
• Consult technical consultants in the official customer WeChat group

Note: Third-party plugins are also external plugins and are used in the same way.

2.5. Note

• The version of the plugin must be consistent with the SDK. If one side is upgraded, both sides need to be updated at the same time. Remember, do not update only one side.
  • Starting from version v1.24.1, use the /dist/web/ directory to achieve simultaneous updates. Because the SDK and the plugin are both in this directory, as long as the references are pointing here, they can be updated simultaneously.
• The SDK version requirement here is the minimum SDK version required when the plugin has the latest features.
• The plugin does not have its own version number. If the plugin is modified, the overall version will increase.
• If GitHub is not accessible, you can also download from npm and check it in the local directory /dist/web/plugin.