From 386f80728622b295c74761558fab582e121abc60 Mon Sep 17 00:00:00 2001 From: amit3200 Date: Wed, 25 Oct 2023 21:17:57 +0530 Subject: [PATCH] :bookmark: release-v2.0.2 --- README.md | 40 ++++++++++++++++++++++++---------------- package.json | 4 ++-- 2 files changed, 26 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index af831f6..6a75b3a 100644 --- a/README.md +++ b/README.md @@ -135,23 +135,31 @@ await percyScreenshotFlutter(driver, name[, { - `driver` (**required**) - A appium driver instance - `name` (**required**) - The screenshot name; must be unique to each screenshot - `options` (**optional**) - There are various options supported by percy_screenshot to server further functionality. - - `freezeAnimation` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations. + - `freezeAnimatedImage` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations. + - `freezeImageBySelectors` - List of selectors. Images will be freezed which are passed using selectors. For this to work `freezeAnimatedImage` must be set to true. + - `freezeImageByXpaths` - List of xpaths. Images will be freezed which are passed using xpaths. For this to work `freezeAnimatedImage` must be set to true. - `percyCSS` - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken. - - `ignoreRegionXpaths` - Elements in the DOM can be ignored using xpath - - `ignoreRegionSelectors` - Elements in the DOM can be ignored using selectors. - - `ignoreRegionAppiumElements` - Elements can be ignored using appium_elements. - - `customIgnoreRegions` - Elements can be ignored using custom boundaries - - IgnoreRegion:- - - Description: This class represents a rectangular area on a screen that needs to be ignored for visual diff. - - Constructor: - ``` - init(self, top, bottom, left, right) - ``` - - Parameters: - - `top` (int): Top coordinate of the ignore region. - - `bottom` (int): Bottom coordinate of the ignore region. - - `left` (int): Left coordinate of the ignore region. - - `right` (int): Right coordinate of the ignore region. + - `ignoreRegionXpaths` - List of xpaths. elements in the DOM can be ignored using xpath + - `ignoreRegionSelectors` - List of selectors. elements in the DOM can be ignored using selectors. + - `ignoreRegionAppiumElements` - List of appium web-element. elements can be ignored using appiumElements. + - `customIgnoreRegions` - List of custom objects. elements can be ignored using custom boundaries. Just passing a simple object for it like below. + - example: ```{top: 10, right: 10, bottom: 120, left: 10}``` + - In above example it will draw rectangle of ignore region as per given coordinates. + - `top` (int): Top coordinate of the ignore region. + - `bottom` (int): Bottom coordinate of the ignore region. + - `left` (int): Left coordinate of the ignore region. + - `right` (int): Right coordinate of the ignore region. + - `considerRegionXpaths` - List of xpaths. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using xpaths. + - `considerRegionSelectors` - List of selectors. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using selectors. + - `considerRegionAppiumElements` - List of appium web-element. elements can be considered for diffing and will be ignored by Intelli Ignore using appium_elements. + - `customConsiderRegions` - List of custom objects. elements can be considered for diffing and will be ignored by Intelli Ignore using custom boundaries + - example: ```{top: 10, right: 10, bottom: 120, left: 10}``` + - In above example it will draw rectangle of consider region will be drawn. + - Parameters: + - `top` (int): Top coordinate of the consider region. + - `bottom` (int): Bottom coordinate of the consider region. + - `left` (int): Left coordinate of the consider region. + - `right` (int): Right coordinate of the consider region. ### Creating Percy on automate build Note: Automate Percy Token starts with `auto` keyword. The command can be triggered using `exec` keyword. ```sh-session diff --git a/package.json b/package.json index b0ae1a2..bbc9f4d 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@percy/appium-app", "description": "Appium client library for visual testing with Percy", - "version": "2.0.2-beta.0", + "version": "2.0.2", "license": "MIT", "author": "Perceptual Inc.", "repository": { @@ -25,7 +25,7 @@ }, "publishConfig": { "access": "public", - "tag": "beta" + "tag": "latest" }, "scripts": { "lint": "eslint --ignore-path .gitignore .",