rrweb

2.2.0 · 24 Oct 2026MIT4.2M / weekRepository Homepage npm Atom feed

Same major only

26 releases in betweennotes for 11

Other targets from 0.9.12Newest 0.x0.9.14

1.0.0 has no release note on GitHub or in the repository's changelog, so its breaking changes are missing from the counts below.

6+
changes to make: 0
advisories fixed: 32+
new: 110+
fixes

Counted from 11 of 26 release notes. Advisories are counted from the advisory database, in full.

Before you upgrade

Tick each one off as you go

Split plugins out of rrweb and move them into their own packages: @rrweb/packer, @rrweb/rrweb-plugin-canvas-webrtc-record, @rrweb/rrweb-plugin-canvas-webrtc-replay, @rrweb/rrweb-plugin-sequential-id-record, @rrweb/rrweb-plugin-sequential-id-replay, @rrweb/rrweb-plugin-console-record, @rrweb/rrweb-plugin-console-replay. Check out the README of each package for more information or check out #1033 to see the changes.
breaking2.0.0
Distributed files have new filenames, paths and extensions. Important: If you reference distributed files or types directly, you might have to update your paths/filenames. E.g. you import from rrweb/typings/... or rrdom/es. However you run import rrweb from 'rrweb' you won't notice a difference with this change. If you include rrweb files directly in a script tag, you might have to update that path to include a the .umd.cjs files instead. All .js files now use ES modules which can be used in modern browsers, node.js and bundlers that support ES modules. All npm packages now also ship .cjs and .umd.cjs files. The .umd.cjs files are CommonJS modules that bundle all files together to make it easy to ship one file to browser environments (similar to the previous .js files). The .cjs files are CommonJS modules that can be used in older Node.js environments. Types should be better defined in package.json and if you need specific types they might be exported from new packages (for example PlayerMachineState and SpeedMachineState are now exported from @rrweb/replay). Check the package.json's main and exports field for the available files.
breaking2.0.0
Move shared rrweb event and recorder types into the new @rrweb/types package.
breaking2.0.0
Remove INode / node.__sn usage and use Mirror as the source of truth.
breaking2.0.0
Move browser-only rrdom features into the new rrdom package.
breaking2.0.0
Mark inlineImages and inlineStylesheet record options as deprecated in docs and public types while preserving existing behavior.
deprecated2.0.0

Release by release

2.2.0
24 Oct 20261 new · 4 fixes
- new
  Add a top-level annotation event with record.addAnnotation() and replayer.on('annotation', handler). Annotation data uses type: 'caption' or type: 'timelineMarker'. Import annotationData from @rrweb/types to type annotation data. The player can display these annotations as captions and interactive timeline markers.
- fixed
  Stopping a recording now releases the root document's mutation buffer and observer — previously the document observer was only disconnected, so each start/stop cycle leaked one buffer — and removes the cross-origin iframe message listener.
- fixed
  A same-origin iframe is observed once instead of re-observed on every full snapshot (checkoutEveryNth/checkoutEveryNms/manual takeFullSnapshot), so a single iframe mutation is no longer emitted once per checkout; its observers are also released when the iframe is removed or navigates away.
- fixed
  The untainted-MutationObserver helper iframe used on WebKit/Safari is reference-counted, so it is torn down only when the last observer stops and will get rebuilt for a later recording.
- fixed
  Disconnect shadow-DOM observers when their host is removed
2.1.7
2 Oct 20261 fix
- fixed
  Fix #1920 - normalization of '0px' in style sheets caused problems with the styled-components library, which built style elements text element by text element. Bug introduced
2.1.6 nothing new or fixed in the note
2.1.5
17 Sep 20262 fixes
- fixed
  Improve performance of untainted dom accessors. Since #1509 we use e.g. dom.parentNode(el) instead of el.parentNode to work around libraries that modify these accessors. Slight improvement to avoid a string allocation each time one of these is called; they are on every hot path.
- fixed
  Improvements in efficiency of mutation handling at record time; has been identified as a problem numerous times
2.1.4 nothing new or fixed in the note
2.1.3
8 Sep 20261 fix
- fixed
  Ignore autoplay attribute mutations on <video>/<audio> regardless of tag-name case.
2.1.2
8 Sep 20262 fixes
- fixed
  Emit custom events even when skipping over them, eg. when seeking to a specific time
- fixed
  Use the provided logger from player config instead of directly calling console.warn
2.1.1 nothing new or fixed in the note

46 internal lines (docs, tests, tooling) left out.

Upgrade to 2.2.0

npm install rrweb@2.2.0

What 2.2.0 needs

Reading 2.2.0's manifest…

Check against your package.json

Which of your other dependencies stand in the way of 2.2.0. Read once, not stored.

After upgrading

Run the type checker, the linter and the tests.
Build, and look for new deprecation warnings.
Update peer dependencies the new version asks for.

Upgrading rrweb from 0.9.12 to 2.2.0

Before you upgrade

Release by release

2.2.0

2.1.7

2.1.5

2.1.3

2.1.2