Files

Justin Halsall aab4c553cb docs: revamp installation docs for esm and umd (#1788 )

* docs: revamp installation docs for esm and umd

Document recommended install paths across the main guides and package
READMEs for rrweb, @rrweb/all, @rrweb/record, @rrweb/replay, and
rrweb-player.

Clarify three usage modes: bundler/npm, browser no-build with
import maps and +esm, and legacy UMD fallback.

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Apply formatting changes

* Apply suggestion from @eoghanmurray

Co-authored-by: Eoghan Murray <eoghan@getthere.ie>

* Apply formatting changes

* docs(all): streamline README usage section

Move the guide link next to the import example and remove the
duplicated Usage section to keep docs concise and easier to scan.

* docs(readme): update gzip size badges in zh-cn readme

* docs(plugins): update readme imports to scoped esm packages

Replace `rrweb` default imports and `rrweb.Replayer` usage with
`@rrweb/record` `record` and `@rrweb/replay` `Replayer` in plugin
usage examples.

Also update canvas WebRTC plugin imports to scoped `@rrweb/*`
package names to keep docs aligned with current package structure.

* docs: update docs to prefer scoped esm packages

replace `rrweb` default import examples with `@rrweb/record` and
`@rrweb/replay` across recipes and guides in en/zh-CN.

clarify package selection for new integrations, add `@rrweb/all`
convenience guidance, and refresh CDN/style import snippets for ESM and legacy UMD compatibility.

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Eoghan Murray <eoghan@getthere.ie>

2026-04-01 12:00:00 +08:00

12 KiB

Raw Blame History

@rrweb/all

Convenience package that includes a bundle of rrweb packages. For most new integrations, prefer @rrweb/record + @rrweb/replay first, and use @rrweb/all when you want a single-package setup.

Use case	Package choice
Most new apps (explicit record/replay dependencies)	`@rrweb/record` + `@rrweb/replay`
Quick setup with one import	`@rrweb/all`
Legacy compatibility	`rrweb`

In most production setups, recorder and replayer are deployed to different pages/apps. Use @rrweb/record on recorded pages and @rrweb/replay (or rrweb-player) on replay pages. Use @rrweb/all when you intentionally want one package for convenience (for example demos, tooling, or simplified setups).

Includes the following packages:

Installation

1) Bundler / npm

npm install @rrweb/all

import { 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 + import maps)

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

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

Use this only for compatibility with non-module environments.

<script src="https://cdn.jsdelivr.net/npm/@rrweb/all@latest/umd/all.min.js"></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.