@rrweb/replay

This package contains all the necessary code to replay recorded events. See the guide for more info on rrweb.

Installation

1) Bundler / npm (Recommended)

npm install @rrweb/replay

import { Replayer } from '@rrweb/replay';
import '@rrweb/replay/dist/style.css';

2) Browser Without Bundler (ESM + import maps)

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/@rrweb/replay@latest/dist/style.css"
/>
<script type="importmap">
  {
    "imports": {
      "@rrweb/replay": "https://cdn.jsdelivr.net/npm/@rrweb/replay@latest/+esm"
    }
  }
</script>
<script type="module">
  import { Replayer } from '@rrweb/replay';
</script>

3) Legacy Direct <script> Include (UMD fallback)

Use this only for compatibility with non-module environments.

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/@rrweb/replay@latest/dist/style.css"
/>
<script src="https://cdn.jsdelivr.net/npm/@rrweb/replay@latest/umd/replay.min.js"></script>

The legacy UMD global is rrwebReplay.

Usage

import { Replayer } from '@rrweb/replay';
import '@rrweb/replay/dist/style.css';

const replayer = new Replayer(events, {
  // options
});
replayer.play();

Notes

Currently this package is really just a wrapper around the Replayer class in the main rrweb package. All Replayer related code will get moved here in the future.

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site.

Gold Sponsors 🥇

<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/0/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/1/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/2/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/3/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/4/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/5/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/6/website?requireActive=false" target="_blank"></a>

Silver Sponsors 🥈

<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/0/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/1/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/2/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/3/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/4/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/5/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/6/website?requireActive=false" target="_blank"></a>

Bronze Sponsors 🥉

<a href="https://opencollective.com/rrweb/tiers/sponsors/0/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/1/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/2/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/3/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/4/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/5/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/6/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/7/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/8/website?requireActive=false" target="_blank"></a>

Backers

<a href="https://opencollective.com/rrweb#sponsor" rel="nofollow"></a>

Core Team Members

_{<b>Yuyz0112</b>}

  </a>
</td>
<td align="center">
  <a href="https://github.com/YunFeng0817">
    
    

_{<b>Yun Feng</b>}

  </a>
</td>
<td align="center">
  <a href="https://github.com/eoghanmurray">
    
    

_{<b>eoghanmurray</b>}

  </a>
</td>
<td align="center">
  <a href="https://github.com/Juice10">
    
    

_{<b>Juice10</b>}

_{open for rrweb consulting} </a> </td>

Who's using rrweb?

  </a>
</td>
<td align="center">
  <a href="https://posthog.com?utm_source=rrweb&utm_medium=sponsorship&utm_campaign=open-source-sponsorship" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://statcounter.com/session-replay/" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://recordonce.com/" target="_blank">
    
  </a>
</td>

  </a>
</td>
<td align="center">
  <a href="https://remsupp.com" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://highlight.io" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://analyzee.io" target="_blank">
    
  </a>
</td>

  </a>
</td>
<td align="center">
  <a href="https://gleap.io" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://uxwizz.com" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://www.howdygo.com" target="_blank">
    
  </a>
</td>