aab4c553cb
* 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>
51 lines
1.3 KiB
Markdown
51 lines
1.3 KiB
Markdown
# Canvas
|
||
|
||
Canvas is a special HTML element, and will not be recorded by rrweb by default.
|
||
There are some options for recording and replaying Canvas.
|
||
|
||
Enable recording Canvas：
|
||
|
||
```js
|
||
import { record } from '@rrweb/record';
|
||
|
||
record({
|
||
emit(event) {},
|
||
recordCanvas: true,
|
||
});
|
||
```
|
||
|
||
Alternatively enable image snapshot recording of Canvas at a maximum of 15 frames per second：
|
||
|
||
```js
|
||
import { record } from '@rrweb/record';
|
||
|
||
record({
|
||
emit(event) {},
|
||
recordCanvas: true,
|
||
sampling: {
|
||
canvas: 15,
|
||
},
|
||
// optional image format settings
|
||
dataURLOptions: {
|
||
type: 'image/webp',
|
||
quality: 0.6,
|
||
},
|
||
});
|
||
```
|
||
|
||
Enable replaying Canvas：
|
||
|
||
```js
|
||
import { Replayer } from '@rrweb/replay';
|
||
|
||
const replayer = new Replayer(events, {
|
||
UNSAFE_replayCanvas: true,
|
||
});
|
||
replayer.play();
|
||
```
|
||
|
||
**Enable replaying Canvas will remove the sandbox, which may cause a potential security issue.**
|
||
|
||
Alternatively you can stream canvas elements via webrtc with the [rrweb-plugin-canvas-webrtc-record](../../packages/plugins/rrweb-plugin-canvas-webrtc-record/) & [rrweb-plugin-canvas-webrtc-replay](../../packages/plugins/rrweb-plugin-canvas-webrtc-replay) plugins.
|
||
For more information see [canvas-webrtc documentation](../../packages/plugins/rrweb-plugin-canvas-webrtc-record/Readme.md)
|