forked from karol-brejna-i/webpage-screenshot-action
-
Notifications
You must be signed in to change notification settings - Fork 0
/
action.yml
98 lines (97 loc) · 3.32 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
name: 'Webpage Screenshot'
author: 'Karol Brejna'
description: 'Take a screenshot of a webpage or its element. Optionally, run a script (in the browser) before taking the screenshot.'
branding:
icon: 'layout'
color: 'blue'
inputs:
url:
description: 'The URLs of the pages to be captured'
required: true
mode:
description: |
Mode of operation. Possible values:
* page
* wholePage
* scrollToElement
* element - capture a specific element by selector (see: "selector" and "xpath" input)
default: wholePage
selector:
description: |
CSS selector of the element to be captured or element to which the view should be scrolled.
Can be used in "element" and "scrollToElement" modes.
Use "selector" or "xpath" input, not both.
required: false
xpath:
description: |
xpath expression for the element to be captured or element to which the view should be scrolled.
Can be used in "element" and "scrollToElement" modes.
Use "selector" or "xpath" input, not both.
required: false
scriptBefore:
description: |
Script to be executed before the screenshot is taken.
Can be used in "script", "page", "wholePage" mode.
required: false
userAgent:
description: |
Overwrite the default browser user agent with a custom one.
required: false
default: ""
type:
description: |
Specify screenshot type, can be `jpeg`, `png` or `webp`.
Defaults to 'png'.
required: false
default: png
quality:
description: |
The quality of the image, between 0-100. Not applicable to `png` images.
required: false
default: ""
isMobile:
description: 'Whether the meta viewport tag is taken into account. Defaults to `false`.'
required: false
default: ""
hasTouch:
description: 'Specifies if viewport supports touch events. Defaults to `false`'
required: false
default: ""
isLandscape:
description: 'Specifies if viewport is in landscape mode. Defaults to `false`.'
required: false
default: ""
width:
description: 'Viewport width in pixels. If not specified, the default browser width will be used (800).'
required: false
default: "800"
height:
description: 'Viewport height in pixels. If not specified, the default browser height will be used (600).'
required: false
default: "600"
deviceScaleFactor:
description: 'Device scale factor. If not specified, the default browser device scale factor will be used (1).'
required: false
default: "1"
omitBackground:
description: 'Hides default white background and allows capturing screenshots with transparency. Defaults to `true`.'
required: false
default: "true"
encoding:
description: 'The encoding of the image, can be either `base64` or `binary`. Defaults to `binary`.'
required: false
default: "binary"
output:
description: 'Output file name/path. If not specified, the screenshot will be saved to "screenshot.png" in the current directory.'
required: false
default: screenshot.png
debugInfo:
description: 'If set to true, the debug information will be printed to the console.'
required: false
default: ""
outputs:
scriptResult:
description: 'JSON string with the result of the script execution.'
runs:
using: 'node16'
main: 'dist/index.js'