This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Is Element Displayed

Determine if an element is currently displayed

Example Usage

MobileElement element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID");
boolean isDisplayed = element.isDisplayed();

self.driver.find_element_by_accessibility_id('SomeAccessibilityID').is_displayed()

// webdriver.io example
let isDisplayed = $("~SomeAccessibilityId").isDisplayed();

// wd example
let element = await driver.elementByAccessibilityId("SomeAccessibilityID");
let isDisplayed = await element.isDisplayed();

# ruby_lib example
find_element(:accessibility_id, "SomeAccessibilityID").displayed?

# ruby_lib_core example
@driver.find_element(:accessibility_id, "SomeAccessibilityID").displayed?

var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
bool isDisplayed = element.Displayed;

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation 8.0 to 9.3 All All
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.3+ All All
Mac Mac ?+ 1.6.4+ All
Windows Windows 10+ 1.6.0+ All

Appium Clients

Language Support Documentation
Java All seleniumhq.github.io
Python All selenium-python.readthedocs.io
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby All www.rubydoc.info
C# All github.com

HTTP API Specifications

Endpoint

GET /session/:session_id/element/:element_id/displayed

URL Parameters

name description
session_id ID of the session to route the command to
element_id ID of the element to check if it is displayed

JSON Parameters

None

Response

Whether the element is displayed (boolean)

See Also