Skip to content

scrollUntilTextIsVisible

Scrolls the screen in the specified direction until a target element becomes visible in the view hierarchy.

Provide EXACTLY ONE target: - ‘text’ — substring match: finds elements where this text appears anywhere within the element’s text. - ‘textRegex’ — anchored full-match regex, used verbatim (the same semantics selector tools use), so ‘Loyalty’ matches only “Loyalty” and not “Loyalty Enroll”. Use this when you need an exact match. - (or ‘id’ alone) — scroll until the element with this id is visible.

At least one of ‘text’, ‘textRegex’, or ‘id’ is required; a call with none is rejected (it would match every element). If both ‘text’ and ‘textRegex’ are given, ‘textRegex’ takes precedence. Only provide the additional disambiguation fields (e.g. ‘index’) when multiple elements match the same target.

Source

  • Kind: class-backed
  • Class: xyz.block.trailblaze.toolcalls.commands.ScrollUntilTextIsVisibleTrailblazeTool

Contract

  • Visible to LLM: yes (surface_to_llm: true)
  • Recordable: yes (is_recordable: true)
  • Host-only: no (requires_host: false)

Input schema

Optional parameters

  • text — String Text to search for while scrolling (substring match). Provide this OR ‘textRegex’.
  • textRegex — String Full-match regex to scroll until visible, used verbatim (anchored, like selector tools). Use instead of ‘text’ for an exact match, e.g. ‘Loyalty’ won’t match ‘Loyalty Enroll’.
  • id — String The element id to scroll until. At least one of ‘text’, ‘textRegex’, or ‘id’ is required.
  • index — Integer A 0-based index to disambiguate multiple views with the same text. Default is ‘0’.
  • direction — ToolParameterType.Enum( entries = [UP, DOWN, RIGHT, LEFT] ) Direction to scroll. Default is ‘DOWN’.
  • visibilityPercentage — Integer Percentage of element visible in viewport. Default is ‘100’.
  • centerElement — Boolean If it will attempt to stop scrolling when the element is closer to the screen center. Default is ‘false’.
  • scrollStartPosition — ToolParameterType.Enum( entries = [CENTER, TOP, BOTTOM] ) Which part of the screen to scroll from. Default is ‘CENTER’.
  • reasoning — String

Output

Returns: string (opaque text content)

Typed result schemas (kind: query | action, MCP structuredContent) are not yet carried by the resolved manifest — this section will gain detail when that lands.