JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1019231
  • Score
    100M100P100Q193364F
  • License MIT

rrweb's component to take a snapshot of DOM, aka DOM serializer

Package Exports

  • rrweb-snapshot

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rrweb-snapshot) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

rrweb-snapshot

Build Status

Snapshot the DOM into a stateful and serializable data structure. Also provide the ability to rebuild the DOM via snapshot.

API

This module export 3 methods:

snapshot

snapshot will traverse the DOM and return a stateful and serializable data structure which can represent the current DOM view.

There are serveral 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 a id to each Node, and return the id node map when snapshot finished.

rebuild

rebuild will build the DOM according to the taken snapshot.

There are serveral things will be done during rebuild:

  1. Add data-rrid attribute if 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.