mirror of
https://github.com/appium/appium.git
synced 2026-02-11 04:20:00 -06:00
186 lines
4.8 KiB
Markdown
186 lines
4.8 KiB
Markdown
# Finding and interacting with elements
|
|
|
|
Appium supports a subset of the WebDriver locator strategies:
|
|
|
|
* find by "tag name" (i.e., ui component type)
|
|
* find by "name" (i.e., the text, label, or developer-generated ID a.k.a
|
|
'accessibilityIdentifier' of an element)
|
|
NOTE: the "name" locator strategy will be deprecated on mobile devices,
|
|
and will not be a part of Appium v1.0
|
|
* find by "xpath" (i.e., an abstract representation of a path to an element,
|
|
with certain constraints)
|
|
|
|
Appium additionally supports some of the [Mobile JSON Wire Protocol](https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile) locator strategies
|
|
|
|
* `-ios uiautomation`: a string corresponding to a recursive element search
|
|
using the UIAutomation library (iOS-only)
|
|
* `-android uiautomator`: a string corresponding to a recursive element
|
|
search using the UiAutomator Api (Android-only)
|
|
* `accessibility id`: a string corresponding to a recursive element search
|
|
using the Id/Name that the native Accessibility options utilize.
|
|
|
|
## Tag name mapping
|
|
|
|
You can use the direct UIAutomation component type name for the tag name,
|
|
or use the simplified mapping (used in some examples below) found here:
|
|
|
|
https://github.com/appium/appium-uiauto/blob/master/uiauto/lib/mechanic.js#L30
|
|
|
|
## Issues
|
|
|
|
There's a known issue with table cell elements becoming invalidated before
|
|
there's time to interact with them. We're working on a fix
|
|
|
|
## Examples
|
|
|
|
### Find all the UIAButtons on the screen
|
|
|
|
WD.js:
|
|
|
|
```js
|
|
driver.elementsByTagName('button', function(err, buttons) {
|
|
// tap all the buttons
|
|
var tapNextButton = function() {
|
|
var button = buttons.shift();
|
|
if (typeof button !== "undefined") {
|
|
button.click(function(err) {
|
|
tapNextButton();
|
|
})
|
|
} else {
|
|
driver.quit();
|
|
}
|
|
}
|
|
tapNextButton();
|
|
});
|
|
```
|
|
|
|
Ruby:
|
|
|
|
```ruby
|
|
buttons = @driver.find_elements :tag_name, :button
|
|
buttons.each { |b| b.click }
|
|
```
|
|
|
|
Python:
|
|
|
|
```python
|
|
[button.click() for button in driver.find_elements_by_tag_name('button')]
|
|
```
|
|
|
|
### Find the element with the text (or accessibilityIdentifier) "Go"
|
|
|
|
WD.js:
|
|
|
|
```js
|
|
driver.elementByName('Go', function(err, el) {
|
|
el.tap(function(err) {
|
|
driver.quit();
|
|
});
|
|
});
|
|
```
|
|
|
|
Ruby:
|
|
|
|
```ruby
|
|
@driver.find_element(:name, 'Go').click
|
|
```
|
|
|
|
Python:
|
|
|
|
```python
|
|
driver.find_element_by_name('Go').click()
|
|
```
|
|
|
|
### Find the nav bar text element where the text begins with "Hi, "
|
|
|
|
WD.js:
|
|
|
|
```js
|
|
driver.elementByXpath('//navigationBar/text[contains(@value, "Hi, ")]', function(err, el) {
|
|
el.text(function(err, text) {
|
|
console.log(text);
|
|
driver.quit();
|
|
});
|
|
});
|
|
```
|
|
|
|
Ruby:
|
|
|
|
```ruby
|
|
@driver.find_element :xpath, '//navigationBar/text[contains(@value, "Hi, ")]'
|
|
```
|
|
|
|
### Find an element by tagName
|
|
|
|
Java:
|
|
|
|
```java
|
|
driver.findElement(By.tagName("button")).sendKeys("Hi");
|
|
|
|
WebELement element = findElement(By.tagName("button"));
|
|
element.sendKeys("Hi");
|
|
|
|
List<WebElement> elems = findElements(By.tagName("button"));
|
|
elems.get(0).sendKeys("Hi");
|
|
```
|
|
|
|
Python:
|
|
|
|
```python
|
|
driver.find_elements_by_tag_name('tableCell')[5].click()
|
|
```
|
|
|
|
### Using the "-ios uiautomation" locator strategy
|
|
|
|
WD.js:
|
|
|
|
```js
|
|
driver.element('-ios uiautomation', '.elements()[1].cells()[2]').getAttribute('name');
|
|
```
|
|
|
|
### Using the "-android uiautomator" locator strategy
|
|
|
|
WD.js:
|
|
|
|
```js
|
|
driver.element('-android uiautomator', 'new UiSelector().clickable(true)').getAttribute('name');
|
|
```
|
|
|
|
### Pull to refresh using a swipe gesture
|
|
|
|
Python:
|
|
|
|
```python
|
|
js_snippet = "mobile: swipe"
|
|
args = {'startX':0.5, 'startY':0.2, 'startX':0.5, 'startY':0.95, 'tapCount':1, 'duration':10}
|
|
driver.execute_script(js_snippet, args)
|
|
```
|
|
|
|
## Using The Appium Inspector To Locate Elements
|
|
|
|
Appium provides you with a neat tool that allows you to find the the elements
|
|
you're looking for without leaving the Appium app. With the Appium Inspector
|
|
(the i symbol next to the start test button) you can find any element and
|
|
it's name by either clicking the element on the preview page provided,
|
|
or locating it in the UI navigator.
|
|
|
|
### Overview
|
|
|
|
The Appium inspector has a simple layout, complete with a UI navigator,
|
|
a preview, and record and refresh buttons, and interaction tools.
|
|
|
|
|
|
|
|
### Example
|
|
|
|
After launching the Appium Inspector (you can do this by clicking the small
|
|
"i" button in the top right of the app) you can locate any element in the
|
|
preview. In this test, I'm looking for the id of the "show alert" button.
|
|
|
|
|
|
|
|
To find the id of this button, I click the "show alert" button in the
|
|
inspector preview. The Appium inspector then highlights the element in the UI
|
|
navigator, showing me both the id and element type of the button I clicked.
|
|
|
|
 |