rrweb
Advanced tools
Package description
rrweb is a library for recording and replaying user interactions on web applications. It captures user events such as clicks, scrolls, and form inputs, and allows you to replay these events to understand user behavior or debug issues.
Recording User Interactions
This feature allows you to record user interactions on a web page. The `record` function starts recording and emits events that can be sent to a server or saved locally.
const rrweb = require('rrweb');
const stopFn = rrweb.record({
emit(event) {
// send event to your server or save it locally
console.log(event);
},
});
// To stop recording
stopFn();Replaying Recorded Sessions
This feature allows you to replay recorded sessions. The `rrwebPlayer` takes the recorded events and replays them in a specified container element.
const rrwebPlayer = require('rrweb-player');
new rrwebPlayer({
target: document.body, // the container element
data: {
events: [], // the array of recorded events
},
});Custom Event Handling
This feature allows you to handle custom events during the recording. You can filter and process specific types of events as needed.
const rrweb = require('rrweb');
const stopFn = rrweb.record({
emit(event) {
if (event.type === 'custom') {
// handle custom event
console.log('Custom event:', event);
}
},
});
// To stop recording
stopFn();FullStory is a digital experience analytics platform that captures and analyzes user interactions on web and mobile applications. It provides similar functionalities to rrweb but includes advanced analytics and insights.
Hotjar is a behavior analytics and user feedback service that helps you understand how users interact with your website. It offers features like heatmaps, session recordings, and surveys, similar to rrweb but with additional user feedback tools.
Mouseflow is a session replay and heatmap tool that tracks user interactions on your website. It provides functionalities similar to rrweb, including session recordings and heatmaps, but also offers funnel analysis and form analytics.
Readme
The new adventure of the rrweb community
I have joined Github Sponsors and highly appreciate your sponsorship.
rrweb refers to 'record and replay the web', which is a tool for recording and replaying users' interactions on the web.
Currently, rrweb has already solved many difficult problems in recording and replaying, but the data structure may still be changed before the release of Version 1.0. So please be cautious to use rrweb in the production environment.
📚 Read the rrweb guide here. 📚
rrweb is mainly composed of 3 parts:
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.
npm install to install required dependencies.In addition to adding integration tests and unit tests, rrweb also provides a REPL testing tool.
FAQs
record and replay the web
We found that rrweb demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.