@rrweb/all
v2.1.0
Published
Convenience package that includes a bundle of rrweb packages.
Readme
@rrweb/all
Overview
Convenience package that includes a bundle of rrweb packages.
In most production setups, the recorder and replayer are deployed to different pages/apps. Use @rrweb/record on recorded pages and @rrweb/replay (or rrweb-player to include UI) on replay pages.
| Use case | Package choice |
| --------------------------------------------------- | --------------------------------- |
| Most new apps (explicit record/replay dependencies) | @rrweb/record + @rrweb/replay |
| Single import for record, replay + packer | @rrweb/all |
Use @rrweb/all when you intentionally want one package for convenience (for example demos, tooling, or simplified setups); the deprecated rrweb package also served a similar all-in-one purpose.
Includes the following packages:
Installation
1) Bundler / npm
npm install @rrweb/allimport { record, Replayer, pack, unpack } from '@rrweb/all';
import '@rrweb/all/dist/style.css';For API details and examples, see the guide.
2) Browser Without Bundler (ESM)
<link rel="stylesheet" href="https://cdn.rrweb.com/all/current/style.css" />
<script type="module">
import {
record,
Replayer,
pack,
unpack,
} from 'https://cdn.rrweb.com/all/current/all.js';
</script>Use current for the latest stable release, or pin an exact version such as
https://cdn.rrweb.com/all/2.0.1/all.js and
https://cdn.rrweb.com/all/2.0.1/style.css for immutable production URLs. See the
CDN assets docs for the full URL
shape and catalog.
3) Legacy Direct <script> Include (UMD fallback)
Use this only for compatibility with non-module environments.
<link rel="stylesheet" href="https://cdn.rrweb.com/all/current/style.css" />
<script src="https://cdn.rrweb.com/all/current/all.umd.cjs"></script>The legacy UMD global is rrweb, so you will need to prefix the example APIs, e.g. rrweb.record, new rrweb.Replayer(...), rrweb.pack, and rrweb.unpack, rather than using these functions directly.
Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site.
Gold Sponsors 🥇
Silver Sponsors 🥈
Bronze Sponsors 🥉
