​
Description

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.

​
Arguments

ArgumentTypeDescription
descriptionstringA description of the image and what it represents.
directionstringThe direction to scroll. Available directions are: up, down, left, right.
distancenumber(Optional) The maximum number of pixels to scroll before giving up. Default is 1200.

​
Example usage

command: scroll-until-image
description: Submit at the bottom of the form
direction: down

​
Protips

  • Use clear and concise descriptions for the image to improve detection accuracy.
  • Adjust the distance value to control how far the command scrolls before giving up.
  • Combine this command with other commands like hover-image or match-image to interact with the located image.

​
Gotchas

  • If the image can’t be located within the specified distance, the command will fail.
  • Ensure the description accurately represents the image to avoid detection issues.

​
Notes

  • The scroll-until-image command is ideal for navigating to visual elements that are off-screen and can’t be located using text-based commands.
  • This command supports both vertical and horizontal scrolling for flexible navigation.