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>
36 lines
811 B
Markdown
36 lines
811 B
Markdown
# Record And Replay
|
|
|
|
Record and Replay is the most common use case, which is suitable for any scenario that needs to collect user behaviors and replay them.
|
|
|
|
You only need a simple API call to record the website:
|
|
|
|
```js
|
|
import { record } from '@rrweb/record';
|
|
|
|
const stopFn = record({
|
|
emit(event) {
|
|
// save the event
|
|
},
|
|
});
|
|
```
|
|
|
|
You can use any approach to store the recorded events, like sending the events to your backend and save them into the database.
|
|
|
|
But you should guarantee:
|
|
|
|
- a set of events are sorted by its timestamp
|
|
- save every event
|
|
|
|
You can use the `stopFn` to stop the recording.
|
|
|
|
Replay is also as simple as passing events into `Replayer`.
|
|
|
|
```js
|
|
import { Replayer } from '@rrweb/replay';
|
|
|
|
const events = GET_YOUR_EVENTS;
|
|
|
|
const replayer = new Replayer(events);
|
|
replayer.play();
|
|
```
|