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>
This commit is contained in:
@@ -26,7 +26,9 @@
|
||||
**示例 1**
|
||||
|
||||
```js
|
||||
rrweb.record({
|
||||
import { record } from '@rrweb/record';
|
||||
|
||||
record({
|
||||
emit(event) {},
|
||||
sampling: {
|
||||
// 不录制鼠标移动事件
|
||||
@@ -46,7 +48,9 @@ rrweb.record({
|
||||
**示例 2**
|
||||
|
||||
```js
|
||||
rrweb.record({
|
||||
import { record } from '@rrweb/record';
|
||||
|
||||
record({
|
||||
emit(event) {},
|
||||
sampling: {
|
||||
// 定义不录制的鼠标交互事件类型,可以细粒度的开启或关闭对应交互录制
|
||||
@@ -74,9 +78,9 @@ rrweb 提供了一个基于 fflate 的简单压缩函数,在 [@rrweb/packer](.
|
||||
```js
|
||||
import { pack } from '@rrweb/packer';
|
||||
|
||||
rrweb.record({
|
||||
record({
|
||||
emit(event) {},
|
||||
packFn: rrweb.pack,
|
||||
packFn: pack,
|
||||
});
|
||||
```
|
||||
|
||||
@@ -84,9 +88,10 @@ rrweb.record({
|
||||
|
||||
```js
|
||||
import { unpack } from '@rrweb/packer';
|
||||
import { Replayer } from '@rrweb/replay';
|
||||
|
||||
const replayer = new rrweb.Replayer(events, {
|
||||
unpackFn: rrweb.unpack,
|
||||
const replayer = new Replayer(events, {
|
||||
unpackFn: unpack,
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user