Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .changeset/thirty-shirts-grow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
"all": patch
"packer": patch
"plugins": patch
"record": patch
"replay": patch
"rrdom": patch
"rrdom-nodejs": patch
"rrweb": patch
"rrweb-player": patch
"rrweb-snapshot": patch
"types": patch
"utils": patch
---

Provide a /umd/ output folder alongside the /dist/ one so that we can serve UMD (Universal Module Definition) files with a .js extension, without upsetting expectations set by package.json that all .js files in /dist/ are modules
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ temp
# output of `yarn build`
build
dist
umd

# turbo cache
.turbo
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
[![Join the chat at slack](https://img.shields.io/badge/[email protected]?logo=slack)](https://join.slack.com/t/rrweb/shared_invite/zt-siwoc6hx-uWay3s2wyG8t5GpZVb8rWg)
[![Twitter Follow](https://img.shields.io/badge/twitter-@rrweb__io-teal.svg?logo=twitter)](https://twitter.com/rrweb_io)
![total gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/rrweb@latest/dist/rrweb.min.cjs?compression=gzip&label=total%20gzip%20size)
![recorder gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/rrweb@latest/dist/record/rrweb-record.min.cjs?compression=gzip&label=recorder%20gzip%20size)
![recorder gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@rrweb/record@latest/umd/record.min.js?compression=gzip&label=recorder%20gzip%20size)
[![](https://data.jsdelivr.com/v1/package/npm/rrweb/badge)](https://www.jsdelivr.com/package/npm/rrweb)

[中文文档](./README.zh_CN.md)
Expand Down
2 changes: 1 addition & 1 deletion README.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

[![Join the chat at slack](https://img.shields.io/badge/[email protected]?logo=slack)](https://join.slack.com/t/rrweb/shared_invite/zt-siwoc6hx-uWay3s2wyG8t5GpZVb8rWg)
![total gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/rrweb@latest/dist/rrweb.min.cjs?compression=gzip&label=total%20gzip%20size)
![recorder gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/rrweb@latest/dist/record/rrweb-record.min.cjs?compression=gzip&label=recorder%20gzip%20size)
![recorder gzip size](https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@rrweb/record@latest/umd/record.min.js?compression=gzip&label=recorder%20gzip%20size)
[![](https://data.jsdelivr.com/v1/package/npm/rrweb/badge)](https://www.jsdelivr.com/package/npm/rrweb)

> 我已开通 Github Sponsor, 您可以通过赞助的形式帮助 rrweb 的开发。
Expand Down
8 changes: 4 additions & 4 deletions guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ You are recommended to install rrweb via jsdelivr's CDN service:
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/rrweb@latest/dist/style.css"
/>
<script src="https://cdn.jsdelivr.net/npm/rrweb@latest/dist/rrweb.umd.min.cjs"></script>
<script src="https://cdn.jsdelivr.net/npm/rrweb@latest/umd/rrweb.min.js"></script>
```

Also, you can link to a specific version number that you can update manually:

```html
<script src="https://cdn.jsdelivr.net/npm/[email protected].14/dist/rrweb.umd.min.cjs"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected].19/umd/rrweb.min.js"></script>
```

#### Only include the recorder code
Expand All @@ -30,7 +30,7 @@ rrweb's code includes both the record and the replay parts. Most of the time you
This also can be done by using the `@rrweb/record` package and the CDN service:

```html
<script src="https://cdn.jsdelivr.net/npm/@rrweb/record@latest/dist/record.umd.min.cjs"></script>
<script src="https://cdn.jsdelivr.net/npm/@rrweb/record@latest/umd/record.min.js"></script>
```

#### Other packages
Expand Down Expand Up @@ -326,7 +326,7 @@ rrweb-player can also be included with `<script>`:
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/rrweb-player@latest/dist/style.css"
/>
<script src="https://cdn.jsdelivr.net/npm/rrweb-player@latest/dist/index.js"></script>
<script src="https://cdn.jsdelivr.net/npm/rrweb-player@latest/umd/rrweb-player.js"></script>
```

Or installed by using NPM:
Expand Down
8 changes: 4 additions & 4 deletions guide.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/rrweb@latest/dist/style.css"
/>
<script src="https://cdn.jsdelivr.net/npm/rrweb@latest/dist/rrweb.umd.min.cjs"></script>
<script src="https://cdn.jsdelivr.net/npm/rrweb@latest/umd/rrweb.min.js"></script>
```

也可以在 URL 中指定具体的版本号,例如:

```html
<script src="https://cdn.jsdelivr.net/npm/[email protected].14/dist/rrweb.umd.min.cjs"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected].19/umd/rrweb.min.js"></script>
```

#### 仅引入录制部分

rrweb 代码分为录制和回放两部分,大多数时候用户在被录制的应用中只需要引入录制部分代码。同样可以通过使用 @rrweb/record 包和 CDN 服务来实现:

```html
<script src="https://cdn.jsdelivr.net/npm/@rrweb/record@latest/dist/record.umd.min.cjs"></script>
<script src="https://cdn.jsdelivr.net/npm/@rrweb/record@latest/umd/record.min.js"></script>
```

#### 其他包
Expand Down Expand Up @@ -320,7 +320,7 @@ rrweb-player 同样可以使用 CDN 方式安装:
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/rrweb-player@latest/dist/style.css"
/>
<script src="https://cdn.jsdelivr.net/npm/rrweb-player@latest/dist/index.js"></script>
<script src="https://cdn.jsdelivr.net/npm/rrweb-player@latest/umd/rrweb-player.js"></script>
```

或者通过 npm 安装:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
}
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
}
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
1 change: 1 addition & 0 deletions packages/plugins/rrweb-plugin-console-record/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
}
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
1 change: 1 addition & 0 deletions packages/plugins/rrweb-plugin-console-replay/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
}
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
}
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
}
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
1 change: 1 addition & 0 deletions packages/record/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
}
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
1 change: 1 addition & 0 deletions packages/replay/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"./dist/style.css": "./dist/style.css"
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
1 change: 1 addition & 0 deletions packages/rrdom-nodejs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
}
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
1 change: 1 addition & 0 deletions packages/rrdom/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
}
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
2 changes: 1 addition & 1 deletion packages/rrweb-player/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ rrweb-player can also be included with `<script>`:
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/rrweb-player@latest/dist/style.css"
/>
<script src="https://cdn.jsdelivr.net/npm/rrweb-player@latest/dist/index.umd.cjs"></script>
<script src="https://cdn.jsdelivr.net/npm/rrweb-player@latest/umd/rrweb-player.js"></script>
```

Or installed by using NPM:
Expand Down
1 change: 1 addition & 0 deletions packages/rrweb-player/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"./dist/style.css": "./dist/style.css"
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
1 change: 1 addition & 0 deletions packages/rrweb-snapshot/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
}
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
1 change: 1 addition & 0 deletions packages/rrweb/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"./dist/style.css": "./dist/style.css"
},
"files": [
"umd",
"dist",
"package.json"
],
Expand Down
Loading
Loading