Package Exports

rrweb
rrweb/dist/rrweb.min
rrweb/dist/rrweb.min.css
rrweb/dist/rrweb.min.js
rrweb/es/rrweb/packages/rrweb/src/entries/all.js
rrweb/es/rrweb/packages/rrweb/src/plugins/console/record
rrweb/es/rrweb/packages/rrweb/src/plugins/console/record/index.js
rrweb/es/rrweb/packages/rrweb/src/record
rrweb/es/rrweb/packages/rrweb/src/record/index.js
rrweb/lib/rrweb-all.cjs
rrweb/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rrweb) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Try rrweb

rrweb

This is a simpler version of the original rrewb README within this rrweb subpackage

中文文档

rrweb refers to 'record and replay the web', which is a tool for recording and replaying users' interactions on the web.

Guide

📚 Read the rrweb guide here. 📚

🍳 Recipes 🍳

Project Structure

rrweb mainly includes two funtions:

Record: The record function is used to record all the mutations in the DOM
Replay: The replay function is to replay the recorded mutations one by one according to the corresponding timestamp.

Roadmap

rrdom: an ad-hoc DOM for rrweb session data #419
storage engine: do deduplication on a large number of rrweb sessions
more end-to-end tests
compact mutation data in common patterns
provide plugins via the new plugin API, including:
- XHR plugin
- fetch plugin
- GraphQL plugin
- ...

Internal Design

Contribute Guide

Since we want the record and replay sides to share a strongly typed data structure, rrweb is developed with typescript which provides stronger type support.

Typescript handbook

Fork this repository.
Run yarn install in the root to install required dependencies for all sub-packages (note: npm install is not recommended).
Run yarn dev in the root to get auto-building for all the sub-packages whenever you modify anything.
Navigate to one of the sub-packages (in the packages folder) where you'd like to make a change.
Patch the code and run yarn test to run the tests, make sure they pass before you commit anything.
Push the code and create a pull request.

Protip: You can run yarn test in the root folder to run all the tests.

In addition to adding integration tests and unit tests, rrweb also provides a REPL testing tool.

Using the REPL tool

Core Team Members

_Yuyz0112

_Mark-Fenng

_eoghanmurray

_Juice10

Who's using rrweb