# rrweb-snapshot
> rrweb's component to take a snapshot of DOM, aka DOM serializer
Latest version **2.1.4** (published 2026-09-08) · MIT license · 0 weekly downloads
## Install
```sh
npm install rrweb-snapshot
pnpm add rrweb-snapshot
yarn add rrweb-snapshot
bun add rrweb-snapshot
```
## Health
**Score 80/100 (A)** — status: active.
Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score; popular repo.
Warnings: low downloads.
## Facts
| | |
|---|---|
| Version | 2.1.4 |
| Published | 2026-09-08 |
| First published | 2018-10-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 20164 |
| Author | rrweb Core Team |
| Maintainers | juice10, yanzhen |
| Keywords | devtools, product-analytics, real-user-monitoring, rrweb, snapshot, DOM |
## Links
- npm: https://www.npmjs.com/package/rrweb-snapshot
- Repository: https://github.com/rrweb-io/rrweb
- Homepage: https://github.com/rrweb-io/rrweb/tree/main/packages/rrweb-snapshot#readme
- Issues: https://github.com/rrweb-io/rrweb/issues
- npm.io page: https://npm.io/package/rrweb-snapshot
## Dependencies (1)
- [postcss](https://npm.io/package/postcss.md) ^8.4.38
## Alternatives
- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads
## Recent versions
- 2.1.4 (latest) — 2026-09-08
- 2.0.0-alpha.20 (alpha) — 2026-02-03
- 2.1.3 — 2026-09-08
- 2.1.2 — 2026-09-08
- 2.1.1 — 2026-07-21
- 2.1.0 — 2026-06-27
- 2.0.1 — 2026-06-03
- 2.0.0 — 2026-06-01
- 2.0.0-alpha.18 — 2024-12-06
- 2.0.0-alpha.17 — 2024-08-02
- 2.0.0-alpha.16 — 2024-06-25
- 2.0.0-alpha.15 — 2024-06-13
- 2.0.0-alpha.14 — 2024-05-22
- 2.0.0-alpha.13 — 2024-04-18
- 2.0.0-alpha.12 — 2024-04-05
- … 94 more at https://npm.io/package/rrweb-snapshot/versions
## README
# rrweb-snapshot
## Overview
Snapshot the DOM into a stateful and serializable data structure.
Also, provide the ability to rebuild the DOM via snapshot.
## API
This module export following methods:
### snapshot
`snapshot` will traverse the DOM and return a stateful and serializable data structure which can represent the current DOM **view**.
There are several things will be done during snapshot:
1. Inline some DOM states into HTML attributes, e.g, HTMLInputElement's value.
2. Turn script tags into `noscript` tags to avoid scripts being executed.
3. Try to inline stylesheets to make sure local stylesheets can be used.
4. Make relative paths in href, src, CSS to be absolute paths.
5. Give an id to each Node, and return the id node map when snapshot finished.
#### rebuild
`rebuild` will build the DOM according to the taken snapshot.
In browser environments, `rebuild()` is a low-level API and requires a document created by `rebuildIntoSandboxedIframe()`, unless `UNSAFE_allowUnprotectedRebuild: true` is passed. Untrusted replay data must not be rebuilt directly into the top-level `document` or a caller-created iframe document.
For browser usage, prefer `rebuildIntoSandboxedIframe`:
`rebuildIntoSandboxedIframe` requires an explicit `root` element.
```ts
const { iframe, node } = rebuildIntoSandboxedIframe(snapshot, {
root: document.body,
cache,
mirror,
});
```
If you need to manage the iframe separately, create it with `createSandboxedIframe()` before calling `rebuild()`.
If you intentionally accept the script-execution risk, pass `UNSAFE_allowUnprotectedRebuild: true` to `rebuild`.
There are several things will be done during rebuild:
1. Add data-rrid attribute if the Node is an Element.
2. Create some extra DOM node like text node to place inline CSS and some states.
3. Add data-extra-child-index attribute if Node has some extra child DOM.
#### serializeNodeWithId
`serializeNodeWithId` can serialize a node into snapshot format with id.
#### buildNodeWithSN
`buildNodeWithSN` will build DOM from serialized node and store serialized information in the `mirror.getMeta(node)`.
## Sponsors
[Become a sponsor](https://opencollective.com/rrweb#sponsor) and get your logo on our README on Github with a link to your site.
### Gold Sponsors 🥇
## Core Team Members
