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
Copy file name to clipboardexpand all lines: README.md
+2
Original file line number
Diff line number
Diff line change
@@ -106,6 +106,7 @@ The screenshot method arguments:
106
106
| FullScreen | Boolean | Indicate whether app is full screen; boolean |
107
107
| ScrollableXpath | String |[Alpha] Scrollable element xpath for fullpage [ needs @percy/cli 1.20.2+ ]|
108
108
| ScrollableId | String |[Alpha] Scrollable element accessibility id for fullpage [ needs @percy/cli 1.20.2+ ]|
109
+
| Sync | Boolean | Waits for screenshot to be processed and gives the processed result of screenshot [From CLI v1.28.0-beta.0+]|
109
110
| IgnoreRegionXpaths | list of string | Elements xpaths that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]|
110
111
| IgnoreRegionAccessibilityIds | list of string | Elements accessibility_ids that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]|
111
112
| IgnoreRegionAppiumElements | list of appium element object | Appium elements that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]|
@@ -180,6 +181,7 @@ class Program
180
181
-`driver` (**required**) - A appium driver instance
181
182
-`name` (**required**) - The screenshot name; must be unique to each screenshot
182
183
-`options` (**optional**) - There are various options supported by percy_screenshot to server further functionality.
184
+
-`sync` - Boolean value by default it falls back to `false`, Gives the processed result around screenshot [From CLI v1.28.0-beta.0+].
183
185
-`freezeAnimatedImage` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations.
184
186
-`freezeImageBySelectors` - List of selectors. Images will be freezed which are passed using selectors. For this to work `freezeAnimatedImage` must be set to true.
185
187
-`freezeImageByXpaths` - List of xpaths. Images will be freezed which are passed using xpaths. For this to work `freezeAnimatedImage` must be set to true.
0 commit comments