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
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.
đ Read the rrweb guide here. đ
rrweb mainly includes two funtions:
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.
yarn install in the root to install required dependencies for all sub-packages (note: npm install is not recommended).yarn dev in the root to get auto-building for all the sub-packages whenever you modify anything.packages folder) where you'd like to make a change.yarn test to run the tests, make sure they pass before you commit anything.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.
Yuyz0112 |
Mark-Fenng |
eoghanmurray |
Juice10 |
|
|
|
|
|
|
FAQs
record and replay the web
The npm package rrweb receives a total of 227,534 weekly downloads. As such, rrweb popularity was classified as popular.
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
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.
Security News
The US Justice Department has penalized two consulting firms $11.3 million for failing to meet cybersecurity requirements on federally funded projects, emphasizing strict enforcement to protect sensitive government data.