Skip to content

Commit c630b96

Browse files
docs: Add snapshotMaxDepth to the troubleshooting doc (#898)
1 parent 765b445 commit c630b96

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1893,6 +1893,7 @@ In case of _xpath_ locators you could try to change values of the following sett
18931893
1. [allowInvisibleElements](#settings-api)
18941894
2. [ignoreUnimportantViews](#settings-api)
18951895
3. [enableMultiWindows](#settings-api)
1896+
4. [snapshotMaxDepth](#settings-api)
18961897

18971898
By default, the first setting is set to `false`, which hides
18981899
elements that are not visible from the page source and from the xpath location. Changing the setting value
@@ -1903,6 +1904,12 @@ that are normally hidden, because of their unimportance.
19031904

19041905
The third setting being set to `true` extends the page source by adding the actual content of other windows that are currently present on the device's screen. For example, the on-screen keyboard in Android is not a part of the current app hierarchy, but rather belongs to a separate window.
19051906

1907+
It only makes sense to change the default value of the `snapshotMaxDepth` setting if the application under test
1908+
has deeply nested elements in the page tree hierarchy (e.g. more than 70 levels), and the destination element
1909+
is suspected to be a part of these deeply nested views. Increasing the value of this
1910+
setting will reduce the performance of xPath searches and page tree retrievals, so be careful while assigning too
1911+
high values to it.
1912+
19061913
In case of _id_ locators you could try to change the value of the following setting:
19071914

19081915
1. [disableIdLocatorAutocompletion](#settings-api)

0 commit comments

Comments
 (0)