Scroll the screen until an image matching the description is found.
The scroll-until-image
command is used to scroll the screen in a specified direction until an image matching the given description is found. This is useful for navigating to visual elements that aren’t initially visible on the screen.
Argument | Type | Description |
---|---|---|
description | string | A description of the image and what it represents. |
direction | string | The direction to scroll. Available directions are: up , down , left , right . |
distance | number | (Optional) The maximum number of pixels to scroll before giving up. Default is 1200 . |
path | string | The relative path to the image file that needs to be matched on the screen. Don’t include testdriver/screenshots/*/ in the path. |
Or, you can use the path
argument to match an image on the screen (similar to match-image
):
distance
value to control how far the command scrolls before giving up.hover-image
or match-image
to interact with the located image.distance
, the command will fail.scroll-until-image
command is ideal for navigating to visual elements that are off-screen and can’t be located using text-based commands.Scroll the screen until an image matching the description is found.
The scroll-until-image
command is used to scroll the screen in a specified direction until an image matching the given description is found. This is useful for navigating to visual elements that aren’t initially visible on the screen.
Argument | Type | Description |
---|---|---|
description | string | A description of the image and what it represents. |
direction | string | The direction to scroll. Available directions are: up , down , left , right . |
distance | number | (Optional) The maximum number of pixels to scroll before giving up. Default is 1200 . |
path | string | The relative path to the image file that needs to be matched on the screen. Don’t include testdriver/screenshots/*/ in the path. |
Or, you can use the path
argument to match an image on the screen (similar to match-image
):
distance
value to control how far the command scrolls before giving up.hover-image
or match-image
to interact with the located image.distance
, the command will fail.scroll-until-image
command is ideal for navigating to visual elements that are off-screen and can’t be located using text-based commands.