You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Interface for managing page overlays that display persistent visual indicators on top of the page.
5
+
6
+
## async method: Overlay.add
7
+
* since: v1.59
8
+
- returns: <[Disposable]>
9
+
10
+
Adds an overlay with the given HTML content. The overlay is displayed on top of the page until removed. Returns a disposable that removes the overlay when disposed.
11
+
12
+
### param: Overlay.add.html
13
+
* since: v1.59
14
+
-`html` <[string]>
15
+
16
+
HTML content for the overlay.
17
+
18
+
## async method: Overlay.configure
19
+
* since: v1.59
20
+
21
+
Configures overlay behavior.
22
+
23
+
### option: Overlay.configure.actionDelay
24
+
* since: v1.59
25
+
-`actionDelay` <[int]>
26
+
27
+
Delay in milliseconds between actions when overlay is active.
28
+
29
+
## async method: Overlay.hide
30
+
* since: v1.59
31
+
32
+
Hides all overlays without removing them. Overlays can be shown again with [`method: Overlay.show`].
Copy file name to clipboardExpand all lines: docs/src/api/class-screencast.md
-8Lines changed: 0 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,14 +42,6 @@ If a screencast is already active (e.g. started by tracing or video recording),
42
42
43
43
Defaults to 800×800.
44
44
45
-
### option: Screencast.start.annotate
46
-
* since: v1.59
47
-
* langs: js
48
-
-`annotate` ?<[Object]>
49
-
-`delay` ?<[int]> How long each annotation is displayed in milliseconds. Defaults to `500`.
50
-
51
-
If specified, enables visual annotations on interacted elements during screencast. Interacted elements are highlighted with a semi-transparent blue box and click points are shown as red circles.
Copy file name to clipboardExpand all lines: docs/src/api/class-video.md
-7Lines changed: 0 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -144,13 +144,6 @@ Path where the video should be saved when the recording is stopped.
144
144
145
145
Optional dimensions of the recorded video. If not specified the size will be equal to page viewport scaled down to fit into 800x800. Actual picture of the page will be scaled down if necessary to fit the specified size.
146
146
147
-
### option: Video.start.annotate
148
-
* since: v1.59
149
-
-`annotate` ?<[Object]>
150
-
-`delay` ?<[int]> How long each annotation is displayed in milliseconds. Defaults to `500`.
151
-
152
-
If specified, enables visual annotations on interacted elements during video recording. Interacted elements are highlighted with a semi-transparent blue box and click points are shown as red circles.
-`size` ?<[Object]> Size of the recorded video. Optional.
626
626
-`width` <[int]>
627
627
-`height` <[int]>
628
-
-`annotate` ?<[Object]> If specified, visually annotates actions in the video with element highlights and action title subtitles.
629
-
-`delay` ?<[int]> How long each annotation is displayed in milliseconds. Defaults to `500`.
628
+
-`annotate` ?<[Object]> If specified, visually annotates the video with test information and action highlights.
629
+
-`action` ?<[Object]> Controls visual annotations on interacted elements.
630
+
-`delay` ?<[int]> How long each annotation is displayed in milliseconds. Defaults to `500`.
631
+
-`test` ?<[Object]> Controls test information displayed as a status overlay in the video.
632
+
-`level` ?<[TestAnnotationLevel]<"file"|"test"|"step">> Level of the detail to include about the current test.
630
633
631
634
Whether to record video for each test. Defaults to `'off'`.
632
635
*`'off'`: Do not record video.
@@ -636,7 +639,7 @@ Whether to record video for each test. Defaults to `'off'`.
636
639
637
640
To control video size, pass an object with `mode` and `size` properties. If video size is not specified, it will be equal to [`property: TestOptions.viewport`] scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
638
641
639
-
To annotate actions in the video with element highlights and action title subtitles, pass `annotate`with an optional `delay` in milliseconds (defaults to `500`).
642
+
To annotate actions in the video, pass `annotate` with `action` and/or `test` sub-options. The `action` option controls visual highlights on interacted elements with an optional `delay` in milliseconds (defaults to `500`). The `test` option controls which test information is displayed as a status overlay.
Copy file name to clipboardExpand all lines: docs/src/videos.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ await context.close();
38
38
39
39
You can also specify video size and annotation. The video size defaults to the viewport size scaled down to fit 800x800. The video of the viewport is placed in the top-left corner of the output video, scaled down to fit if necessary. You may need to set the viewport size to match your desired video size.
40
40
41
-
When `annotate` is specified, each action will be visually highlighted in the video with the element outline and action title subtitle. The optional `delay` property controls how long each annotation is displayed (defaults to `500`ms).
41
+
When `action` is specified, each action can be visually highlighted in the video with the element outline and action title subtitle, and test information can be shown as a status overlay. The `action` sub-option controls element highlights with an optional `delay` (defaults to `500`ms). The `test` sub-option controls which test information components are displayed.
0 commit comments