You may also want to read the guide to understand the APIs, or read the design docs to know more technical details of rrweb.
Record and Replay is the most common use case, which is suitable for any scenario that needs to collect user behaviors and replay them.
The events recorded by rrweb are a set of strictly-typed JSON data. You may discover some flexible ways to use them when you are familiar with the details.
When the size of the recorded events increased, load them in one request is not performant. You can paginate the events and load them as you need.
If you want to replay the events in a real-time way, you can use the live mode API. This API is also useful for some real-time collaboration usage.
You may need to record some custom events along with the rrweb events, and let them be played as other events. The custom event API was designed for this.
By default, the UI could not interact during replay. But you can use API to enable/disable this programmatically.
When rrweb's Replayer and the rrweb-player UI do not fit your need, you can customize your own replayer UI.
The event data recorded by rrweb is a performant, easy to compress, text-based format. And the replay is also pixel perfect.
But if you really need to convert it into a video format, there are some tools that can do this work.
In some Apps, rrweb may record an unexpected amount of data. This part will help to find a suitable way to optimize the storage.
Canvas is a special HTML element, which will not be recorded by rrweb by default. There are some options for recording and replaying Canvas.
Starting from v1.0.0, we add the plugin to record and play back console output. This feature aims to provide developers with more information about the bug scene. There are some options for recording and replaying console output.
The plugin API is designed to extend the function of rrweb without bump the size and complexity of rrweb's core part.