Skip to content

Commit

Permalink
Updating Readme with example
Browse files Browse the repository at this point in the history
  • Loading branch information
Amit3200 committed Oct 25, 2023
1 parent 8995bba commit 8884887
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,21 +150,23 @@ const driver = new webdriver.Builder().usingServer('https://hub-cloud.browsersta
- `ignoreRegionSelectors` - List of selectors. elements in the DOM can be ignored using selectors.
- `ignoreRegionSeleniumElements` - List of selenium web-element. elements can be ignored using selenium_elements.
- `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 which will be 10px below from top and 120px above from bottom. 10px apart from left and right.
- 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.
- `considerRegionSeleniumElements` - List of selenium web-element. elements can be considered for diffing and will be ignored by Intelli Ignore using selenium_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 ignore region which will be 10px below from top and 120px above from bottom. 10px apart from left and right.

- 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
Expand Down

0 comments on commit 8884887

Please sign in to comment.