DocsElement Statebrowser_is_visible

browser_is_visible

Browser Is Visible

Check if an element is visible on the page. Returns true if the element exists, is displayed (not hidden), and has non-zero dimensions. Useful for conditional logic based on visibility.

Usage Example

123456789101112
import asyncio
from owl_browser import OwlBrowser, RemoteConfig
# Async usage
async with OwlBrowser(config) as browser:
context = await browser.create_context()
context_id = context["context_id"]
await browser.is_visible(
context_id=context_id,
selector="#element-id"
)

Parameters

Required

context_idstringrequired

The unique identifier of the browser context (e.g., 'ctx_000001')

selectorstringrequired

CSS selector or natural language description of the element to check visibility for

Optional

indexstring

When multiple elements match the selector, check the Nth element (0-based). Default: -1 (first match)

Response

Returns a JSON object with the operation result.

{
  "success": true,
  "result": <value>
}