Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

0.9.15-beta #4

Draft
wants to merge 41 commits into
base: master
Choose a base branch
from
Draft

0.9.15-beta #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
0333f38
Register Enter event @ porting from @Juice10’s rrweb
joris Oct 2, 2020
425a040
@Juice10: Add a flag for rrweb generated events
joris Oct 2, 2020
0cf62c0
Do not ignore password fields, but allow them to be masked instead
joris Oct 2, 2020
0159fa1
Copied electron-inject.js from @Juice10/record-once-rrweb
joris Oct 2, 2020
92ca08b
Added build config from @Juice10/record-once-rrweb
joris Oct 2, 2020
2563ecd
Correcting bundle:inject
joris Oct 2, 2020
943b183
Correct dev dependencies
joris Oct 2, 2020
27fbb31
Copied checks from @Juice10/record-once-rrweb/commit/903ab8d883593b51…
joris Oct 2, 2020
f569556
Attempting a postinstall hook…
joris Oct 2, 2020
c210d26
Do not run typings post install
joris Oct 2, 2020
2831dcf
Hopefully this does work
joris Oct 2, 2020
5d9eeea
Removed electron injection
joris Jan 20, 2021
df6973d
Merge branch 'master' of git://github.com/rrweb-io/rrweb into rrweb-i…
joris Jan 20, 2021
3121dfe
Merge pull request #2 from recordonce/rrweb-io-master
joris Jan 20, 2021
339f473
Merge branch 'master' of https://github.com/rrweb-io/rrweb into upgra…
Juice10 Feb 18, 2021
9e4c36f
Revert "Added build config from @Juice10/record-once-rrweb"
Juice10 Feb 18, 2021
7c269d7
add ability to mask passwords
Juice10 Feb 18, 2021
97ad793
Merge pull request #3 from recordonce/upgrade-rrweb
Juice10 Feb 18, 2021
222e2a0
Revert "Correct dev dependencies"
Juice10 Feb 18, 2021
11f822a
add `userTriggered`
Juice10 Feb 18, 2021
31862d8
update snapshots to add userTriggered
Juice10 Feb 18, 2021
8db1a6b
Revert "Do not ignore password fields, but allow them to be masked in…
Juice10 Feb 18, 2021
8a52d91
Merge branch 'mask-passwords' of https://github.com/juice10/rrweb int…
Juice10 Feb 18, 2021
006ea41
Revert "@Juice10: Add a flag for rrweb generated events"
Juice10 Feb 18, 2021
ccbf25b
Merge branch 'user-triggered' of https://github.com/juice10/rrweb int…
Juice10 Feb 18, 2021
52bb343
Revert "Register Enter event @ porting from @Juice10’s rrweb"
Juice10 Feb 18, 2021
e058ae4
align tests
Juice10 Feb 18, 2021
ff84ac9
UNDO ME: temporarily set rrweb-snapshot to juice10's repo
Juice10 Feb 18, 2021
b5c0bef
update types
Juice10 Feb 18, 2021
515b211
Merge branch 'master' of https://github.com/rrweb-io/rrweb into 0.9.1…
Juice10 Feb 18, 2021
ea79779
use prepack instead of prepare
Juice10 Feb 18, 2021
12e0455
after prepack don't remove the build directories
Juice10 Feb 18, 2021
4741c66
maybe this works
Juice10 Feb 18, 2021
b1da6f5
for compatibility add both prepare and prepack
Juice10 Feb 18, 2021
6889d2f
upgrade rrweb snapshot
Juice10 Feb 18, 2021
35eba72
fix: issue #548
YunFeng0817 Apr 26, 2021
c2baa9a
Revert "UNDO ME: temporarily set rrweb-snapshot to juice10's repo"
Juice10 Apr 28, 2021
adecb92
Merge branch 'master' of https://github.com/rrweb-io/rrweb into 0.9.1…
Juice10 Apr 28, 2021
c30fb0d
Merge branch 'iframe-patch' of https://github.com/Mark-Fenng/rrweb in…
Juice10 Apr 28, 2021
5a61cbf
set scope of npm package to recordonce
Juice10 Apr 25, 2021
26d6992
Release 0.9.15-beta.0
Juice10 Apr 28, 2021
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
52 changes: 26 additions & 26 deletions guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,37 +135,37 @@ setInterval(save, 10 * 1000);

The parameter of `rrweb.record` accepts the following options.

| key | default | description |
| ---------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| emit | required | the callback function to get emitted events |
| checkoutEveryNth | - | take a full snapshot after every N events<br />refer to the [checkout](#checkout) chapter |
| checkoutEveryNms | - | take a full snapshot after every N ms<br />refer to the [checkout](#checkout) chapter |
| blockClass | 'rr-block' | Use a string or RegExp to configure which elements should be blocked, refer to the [privacy](#privacy) chapter |
| ignoreClass | 'rr-ignore' | Use a string or RegExp to configure which elements should be ignored, refer to the [privacy](#privacy) chapter |
| maskTextClass | 'rr-mask' | Use a string or RegExp to configure which elements should be masked, refer to the [privacy](#privacy) chapter |
| blockSelector | null | Use a string to configure which selector should be blocked, refer to the [privacy](#privacy) chapter |
| maskTextSelector | null | Use a string to configure which selector should be masked, refer to the [privacy](#privacy) chapter |
| maskAllInputs | false | mask all input content as \* |
| maskInputOptions | {} | mask some kinds of input \*<br />refer to the [list](https://github.com/rrweb-io/rrweb-snapshot/blob/6728d12b3cddd96951c86d948578f99ada5749ff/src/types.ts#L72) |
| maskInputFn | - | customize mask input content recording logic |
| maskTextFn | - | customize mask text content recording logic |
| slimDOMOptions | {} | remove unnecessary parts of the DOM <br />refer to the [list](https://github.com/rrweb-io/rrweb-snapshot/blob/6728d12b3cddd96951c86d948578f99ada5749ff/src/types.ts#L91) |
| inlineStylesheet | true | whether to inline the stylesheet in the events |
| hooks | {} | hooks for events<br />refer to the [list](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L207) |
| packFn | - | refer to the [storage optimization recipe](./docs/recipes/optimize-storage.md) |
| sampling | - | refer to the [storage optimization recipe](./docs/recipes/optimize-storage.md) |
| recordCanvas | false | whether to record the canvas element |
| collectFonts | false | whether to collect fonts in the website |
| recordLog | false | whether to record console output, refer to the [console recipe](./docs/recipes/console.md) |
| key | default | description |
| ---------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| emit | required | the callback function to get emitted events |
| checkoutEveryNth | - | take a full snapshot after every N events<br />refer to the [checkout](#checkout) chapter |
| checkoutEveryNms | - | take a full snapshot after every N ms<br />refer to the [checkout](#checkout) chapter |
| blockClass | 'rr-block' | Use a string or RegExp to configure which elements should be blocked, refer to the [privacy](#privacy) chapter |
| ignoreClass | 'rr-ignore' | Use a string or RegExp to configure which elements should be ignored, refer to the [privacy](#privacy) chapter |
| maskTextClass | 'rr-mask' | Use a string or RegExp to configure which elements should be masked, refer to the [privacy](#privacy) chapter |
| blockSelector | null | Use a string to configure which selector should be blocked, refer to the [privacy](#privacy) chapter |
| maskTextSelector | null | Use a string to configure which selector should be masked, refer to the [privacy](#privacy) chapter |
| maskAllInputs | false | mask all input content as \* |
| maskInputOptions | { password: true } | mask some kinds of input \*<br />refer to the [list](https://github.com/rrweb-io/rrweb-snapshot/blob/6728d12b3cddd96951c86d948578f99ada5749ff/src/types.ts#L72) |
| maskInputFn | - | customize mask input content recording logic |
| maskTextFn | - | customize mask text content recording logic |
| slimDOMOptions | {} | remove unnecessary parts of the DOM <br />refer to the [list](https://github.com/rrweb-io/rrweb-snapshot/blob/6728d12b3cddd96951c86d948578f99ada5749ff/src/types.ts#L91) |
| inlineStylesheet | true | whether to inline the stylesheet in the events |
| hooks | {} | hooks for events<br />refer to the [list](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L207) |
| packFn | - | refer to the [storage optimization recipe](./docs/recipes/optimize-storage.md) |
| sampling | - | refer to the [storage optimization recipe](./docs/recipes/optimize-storage.md) |
| recordCanvas | false | whether to record the canvas element |
| collectFonts | false | whether to collect fonts in the website |
| recordLog | false | whether to record console output, refer to the [console recipe](./docs/recipes/console.md) |

#### Privacy

You may find some contents on the webpage which are not willing to be recorded, then you can use the following approaches:

- An element with the class name `.rr-block` will not be recorded. Instead, it will replay as a placeholder with the same dimension.
- An element with the class name `.rr-ignore` will not record its input events.
- `input[type="password"]` will be ignored as default.
- Mask options to mask the content in input elements.
- `input[type="password"]` will be masked as default.
- A text of elements with the class name `.rr-mask` and its children will be masked.

#### Checkout
Expand Down Expand Up @@ -294,7 +294,7 @@ The replayer accepts options as its constructor's second parameter, and it has t
| showDebug | false | whether to print debug messages during replay |
| blockClass | 'rr-block' | element with the class name will display as a blocked area |
| liveMode | false | whether to enable live mode |
| insertStyleRules | [] | accepts multiple CSS rule string, which will be injected into the replay iframe |
| insertStyleRules | [] | accepts multiple CSS rule string, which will be injected into the replay iframe |
| triggerFocus | true | whether to trigger focus during replay |
| UNSAFE_replayCanvas | false | whether to replay the canvas element. **Enable this will remove the sandbox, which is unsafe.** |
| mouseTail | true | whether to show mouse tail during replay. Set to false to disable mouse tail. A complete config can be found in this [type](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L407) |
Expand Down Expand Up @@ -380,8 +380,8 @@ The rrweb-replayer also re-expose the event listener via a `component.addEventLi

And there are three rrweb-replayer event will be emitted in the same way:

| Event | Description | Value |
| ---------------------- | -------------------------------- | ----------------------- |
| Event | Description | Value |
| ---------------------- | -------------------------------- | ----------- |
| ui-update-current-time | current time has changed | { payload } |
| ui-update-player-state | current player state has changed | { payload } |
| ui-update-progress | current progress has changed | { payload } |
Expand Down
Loading