aab4c553cb
* 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>
241 lines
13 KiB
Markdown
241 lines
13 KiB
Markdown
<p align="center">
|
||
<img width="100px" height="100px" src="https://www.rrweb.io/favicon.png">
|
||
</p>
|
||
<p align="center">
|
||
<a href="https://www.rrweb.io/" style="font-weight: bold">Try rrweb</a>
|
||
</p>
|
||
|
||
# rrweb
|
||
|
||
**[rrweb 纪录片（中文）](https://www.bilibili.com/video/BV1wL4y1B7wN?share_source=copy_web)**
|
||
|
||
[](https://join.slack.com/t/rrweb/shared_invite/zt-siwoc6hx-uWay3s2wyG8t5GpZVb8rWg)
|
||
[](https://www.reddit.com/r/rrweb)
|
||
|
||
|
||
[](https://www.jsdelivr.com/package/npm/rrweb)
|
||
|
||
> 我已开通 Github Sponsor， 您可以通过赞助的形式帮助 rrweb 的开发。
|
||
|
||
rrweb 是 'record and replay the web' 的简写，旨在利用现代浏览器所提供的强大 API 录制并回放任意 web 界面中的用户操作。
|
||
|
||
## 指南
|
||
|
||
[**📚 rrweb 使用指南 📚**](./guide.zh_CN.md)
|
||
|
||
[**🍳 场景示例 🍳**](./docs/recipes/index.zh_CN.md)
|
||
|
||
## 项目结构
|
||
|
||
rrweb 主要由 3 部分组成：
|
||
|
||
- **[rrweb-snapshot](https://github.com/rrweb-io/rrweb/tree/master/packages/rrweb-snapshot/)**，包含 snapshot 和 rebuild 两个功能。snapshot 用于将 DOM 及其状态转化为可序列化的数据结构并添加唯一标识；rebuild 则是将 snapshot 记录的数据结构重建为对应的 DOM。
|
||
- **[rrweb](https://github.com/rrweb-io/rrweb)**，包含 record 和 replay 两个功能。record 用于记录 DOM 中的所有变更（mutation）；replay 则是将记录的变更按照对应的时间一一重放。
|
||
- **[rrweb-player](https://github.com/rrweb-io/rrweb/tree/master/packages/rrweb-player/)**，为 rrweb 提供一套 UI 控件，提供基于 GUI 的暂停、快进、拖拽至任意时间点播放等功能。
|
||
|
||
## Roadmap
|
||
|
||
- storage engine: 对大规模 rrweb 数据进行去重
|
||
- 在常见场景下对 mutation 数据进行压缩
|
||
- 基于新的插件 API 提供更多插件，包括:
|
||
- XHR 插件
|
||
- fetch 插件
|
||
- GraphQL 插件
|
||
- ...
|
||
|
||
## Internal Design
|
||
|
||
- [序列化](./docs/serialization.zh_CN.md)
|
||
- [增量快照](./docs/observer.zh_CN.md)
|
||
- [回放](./docs/replay.zh_CN.md)
|
||
- [沙盒](./docs/sandbox.zh_CN.md)
|
||
|
||
## Contribute Guide
|
||
|
||
为了保证录制和回放时可以对应到一致的数据结构，rrweb 采用 typescript 开发以提供更强的类型支持。
|
||
|
||
[Typescript 手册](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html)
|
||
|
||
1. Fork 需要修改的 rrweb 组件仓库
|
||
2. `yarn install` 安装所需依赖
|
||
3. 修改代码并通过测试
|
||
4. 提交代码，创建 pull request
|
||
|
||
除了添加集成测试和单元测试之外，rrweb 还提供了交互式的测试工具。
|
||
|
||
[使用 REPL 工具](./guide.zh_CN.md#REPL-工具)
|
||
|
||
## 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 🥇
|
||
|
||
<div dir="auto">
|
||
|
||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/0/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/1/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/2/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/3/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/4/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/4/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/5/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/5/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/6/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/gold-sponsor/6/avatar.svg?requireActive=false&avatarHeight=225" alt="sponsor"></a>
|
||
|
||
</div>
|
||
|
||
### Silver Sponsors 🥈
|
||
|
||
<div dir="auto">
|
||
|
||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/0/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/1/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/2/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/3/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/4/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/4/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/5/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/5/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/6/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/silver-sponsor/6/avatar.svg?requireActive=false&avatarHeight=158" alt="sponsor"></a>
|
||
|
||
</div>
|
||
|
||
### Bronze Sponsors 🥉
|
||
|
||
<div dir="auto">
|
||
|
||
<a href="https://opencollective.com/rrweb/tiers/sponsors/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/0/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/sponsors/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/1/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/sponsors/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/2/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/sponsors/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/3/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/sponsors/4/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/4/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/sponsors/5/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/5/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/sponsors/6/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/6/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/sponsors/7/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/7/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||
<a href="https://opencollective.com/rrweb/tiers/sponsors/8/website?requireActive=false" target="_blank"><img src="https://opencollective.com/rrweb/tiers/sponsors/8/avatar.svg?requireActive=false&avatarHeight=70" alt="sponsor"></a>
|
||
|
||
</div>
|
||
|
||
### Backers
|
||
|
||
<a href="https://opencollective.com/rrweb#sponsor" rel="nofollow"><img src="https://opencollective.com/rrweb/tiers/backers.svg?avatarHeight=36"></a>
|
||
|
||
## Core Team Members
|
||
|
||
<table>
|
||
<tr>
|
||
<td align="center">
|
||
<a href="https://github.com/Yuyz0112">
|
||
<img
|
||
src="https://avatars.githubusercontent.com/u/13651389?s=100"
|
||
width="100px;"
|
||
alt=""
|
||
/>
|
||
<br /><sub><b>Yuyz0112</b></sub>
|
||
<br /><br />
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://github.com/YunFeng0817">
|
||
<img
|
||
src="https://avatars.githubusercontent.com/u/27533910?s=100"
|
||
width="100px;"
|
||
alt=""
|
||
/>
|
||
<br /><sub><b>Yun Feng</b></sub>
|
||
<br /><br />
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://github.com/eoghanmurray">
|
||
<img
|
||
src="https://avatars.githubusercontent.com/u/156780?s=100"
|
||
width="100px;"
|
||
alt=""
|
||
/>
|
||
<br /><sub><b>eoghanmurray</b></sub>
|
||
<br /><br />
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://github.com/Juice10">
|
||
<img
|
||
src="https://avatars.githubusercontent.com/u/4106?s=100"
|
||
width="100px;"
|
||
alt=""
|
||
/>
|
||
<br /><sub><b>Juice10</b></sub>
|
||
<br /><sub>open for rrweb consulting</sub>
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
## Who's using rrweb?
|
||
|
||
<table>
|
||
<tr>
|
||
<td align="center">
|
||
<a href="http://www.smartx.com/" target="_blank">
|
||
<img width="195px" src="https://www.rrweb.io/logos/smartx.png">
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://posthog.com?utm_source=rrweb&utm_medium=sponsorship&utm_campaign=open-source-sponsorship" target="_blank">
|
||
<img width="195px" src="https://www.rrweb.io/logos/posthog.png">
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://statcounter.com/session-replay/" target="_blank">
|
||
<img width="195px" src="https://statcounter.com/images/logo-statcounter-arc-blue.svg">
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://recordonce.com/" target="_blank">
|
||
<img width="195px" alt="Smart screen recording for SaaS" src="https://uploads-ssl.webflow.com/5f3d133183156245630d4446/5f3d1940abe8db8612c23521_Record-Once-logo-554x80px.svg">
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<a href="https://cux.io" target="_blank">
|
||
<img style="padding: 8px" alt="The first ever UX automation tool" width="195px" src="https://cux.io/cux-logo.svg">
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://remsupp.com" target="_blank">
|
||
<img style="padding: 8px" alt="Remote Access & Co-Browsing" width="195px" src="https://remsupp.com/images/logo.png">
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://highlight.io" target="_blank">
|
||
<img style="padding: 8px" alt="The open source, fullstack Monitoring Platform." width="195px" src="https://github.com/highlight/highlight/raw/main/highlight.io/public/images/logo.png">
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://analyzee.io" target="_blank">
|
||
<img style="padding: 8px" alt="Comprehensive data analytics platform that empowers businesses to gain valuable insights and make data-driven decisions." width="195px" src="https://cdn.analyzee.io/assets/analyzee-logo.png">
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<a href="https://requestly.io" target="_blank">
|
||
<img style="padding: 8px" alt="Intercept, Modify, Record & Replay HTTP Requests." width="195px" src="https://github.com/requestly/requestly/assets/16779465/652552db-c867-44cb-9bb5-94a2026e04ca">
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://gleap.io" target="_blank">
|
||
<img style="padding: 8px" alt="In-app bug reporting & customer feedback platform." width="195px" src="https://assets-global.website-files.com/6506f3f29c68b1724807619d/6506f56010237164c6306591_GleapLogo.svg">
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://uxwizz.com" target="_blank">
|
||
<img style="padding: 8px" alt="Self-hosted website analytics with heatmaps and session recordings." width="195px" src="https://github.com/UXWizz/public-files/raw/main/assets/logo.png">
|
||
</a>
|
||
</td>
|
||
<td align="center">
|
||
<a href="https://www.howdygo.com" target="_blank">
|
||
<img style="padding: 8px" alt="Interactive product demos for small marketing teams" width="195px" src="https://assets-global.website-files.com/650afb446f1dd5bd410f00cc/650b2cec6188ff54dd9b01e1_Logo.svg">
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
</table>
|