doc: adding "window" to recorder parameters

rrweb-io · Oct 15, 2022 · 81695e8 · 81695e8
1 parent 6cf7933
commit 81695e8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/guide.md b/guide.md
@@ -160,6 +160,7 @@ The parameter of `rrweb.record` accepts the following options.
 | inlineImages         | false              | whether to record the image content                                                                                                                                                           |
 | collectFonts         | false              | whether to collect fonts in the website                                                                                                                                                       |
 | userTriggeredOnInput | false              | whether to add `userTriggered` on input events that indicates if this event was triggered directly by the user or not. [What is `userTriggered`?](https://github.com/rrweb-io/rrweb/pull/495) |
+| window               | window             | Window object to record. When rrweb is loaded from an iframe, inject here the parent `window` Element.                                                                                        |
 | plugins              | []                 | load plugins to provide extended record functions. [What is plugins?](./docs/recipes/plugin.md)                                                                                               |
 
 #### Privacy

diff --git a/guide.zh_CN.md b/guide.zh_CN.md
@@ -156,6 +156,7 @@ setInterval(save, 10 * 1000);
 | inlineImages         | false              | 是否将图片内容记内联录制                                                                                                                                                              |
 | collectFonts         | false              | 是否记录页面中的字体文件                                                                                                                                                              |
 | userTriggeredOnInput | false              | [什么是 `userTriggered`](https://github.com/rrweb-io/rrweb/pull/495)                                                                                                                  |
+| window               | window             |                                                                                                                                                                                |
 | plugins              | []                 | 加载插件以获得额外的录制功能. [什么是插件？](./docs/recipes/plugin.zh_CN.md)                                                                                                          |
 
 #### 隐私