bcf93ca926
* docs: revamp installation docs for esm and umd Document recommended install paths across the main guides and package READMEs for rrweb, @rrweb/all, @rrweb/record, @rrweb/replay, and rrweb-player. Clarify three usage modes: bundler/npm, browser no-build with import maps and +esm, and legacy UMD fallback. * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply formatting changes * Apply suggestion from @eoghanmurray Co-authored-by: Eoghan Murray <eoghan@getthere.ie> * Apply formatting changes * docs(all): streamline README usage section Move the guide link next to the import example and remove the duplicated Usage section to keep docs concise and easier to scan. * docs(readme): update gzip size badges in zh-cn readme * docs(plugins): update readme imports to scoped esm packages Replace `rrweb` default imports and `rrweb.Replayer` usage with `@rrweb/record` `record` and `@rrweb/replay` `Replayer` in plugin usage examples. Also update canvas WebRTC plugin imports to scoped `@rrweb/*` package names to keep docs aligned with current package structure. * docs: update docs to prefer scoped esm packages replace `rrweb` default import examples with `@rrweb/record` and `@rrweb/replay` across recipes and guides in en/zh-CN. clarify package selection for new integrations, add `@rrweb/all` convenience guidance, and refresh CDN/style import snippets for ESM and legacy UMD compatibility. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Eoghan Murray <eoghan@getthere.ie>
3.1 KiB
3.1 KiB
插件
插件 API 的设计目标是在不增加 rrweb 核心部分大小和复杂性的前提下，扩展 rrweb 的功能。
可用插件
- @rrweb/rrweb-plugin-console-record：一个用于记录控制台日志的插件。
- @rrweb/rrweb-plugin-console-replay：一个用于回放控制台日志的插件。
- @rrweb/rrweb-plugin-sequential-id-record：一个用于记录顺序 ID 的插件。
- @rrweb/rrweb-plugin-sequential-id-replay：一个用于回放顺序 ID 的插件。
- @rrweb/rrweb-plugin-canvas-webrtc-record：一个用于通过 WebRTC 流式传输
<canvas>的插件。 - @rrweb/rrweb-plugin-canvas-webrtc-replay：一个用于通过 WebRTC 播放流式
<canvas>的插件。
接口
与 rrweb 其它功能相似，插件可以包含同时包含录制、回放侧的功能，也可以只实现其中任一。
export type RecordPlugin<TOptions = unknown> = {
name: string;
observer: (cb: Function, options: TOptions) => listenerHandler;
options: TOptions;
};
export type ReplayPlugin = {
handler: (
event: eventWithTime,
isSync: boolean,
context: { replayer: Replayer },
) => void;
};
以上是录制和回放插件的接口类型。
示例
录制侧插件
import { record } from '@rrweb/record';
const exampleRecordPlugin: RecordPlugin<{ foo: string }> = {
name: 'my-scope/example@1',
observer(cb, options) {
const timer = setInterval(() => {
cb({
foo: options.foo,
timestamp: Date.now(),
});
}, 1000);
return () => clearInterval(timer);
},
options: {
foo: 'bar',
},
};
record({
emit: emit(event) {},
plugins: [exampleRecordPlugin],
});
在这个示例中，录制侧插件将会输出这样的事件：
{
type: 6,
data: {
plugin: 'my-scope/example@1',
payload: {
foo: 'bar',
timestamp: 1624693882345,
},
},
timestamp: 1624693882345,
}
回放侧插件
import { Replayer } from '@rrweb/replay';
const exampleReplayPlugin: ReplayPlugin = {
handler(event, isSync, context) {
if (event.type === EventType.Plugin) {
// 使用 event.data.payload
if (event.data.plugin === 'my-scope/example@1') {
// 处理示例插件录制的数据
}
}
},
};
const replayer = new Replayer(events, {
plugins: [exampleReplayPlugin],
});
回放侧插件可以通过 context.replayer 与播放器进行交互。
插件命名
录制侧插件应该拥有全局唯一的名称，并且其名称会被记录在输出的事件中。
由于会同时存在 rrweb 仓库中的官方插件与用户自行实现的自定义插件，所以我们推荐使用统一的命名规则避免冲突，命名方式如下：
scope/name@version
例如： rrweb/console@1 或 github/pr@2。