Skip to content

Latest commit

 

History

History
117 lines (87 loc) · 3.03 KB

APIRef.ActionsOnElement.md

File metadata and controls

117 lines (87 loc) · 3.03 KB
Raw
id title
APIRef.ActionsOnElement
Actions on Element

Detox uses Matchers to find UI elements in your app, Actions to emulate user interaction with those elements and Expectations to verify values on those elements.

Actions

Actions are functions that emulate user behavior. They are being performed on matched elements.

Methods

tap()

Simulate tap on an element.

await element(by.id('tappable')).tap();

longPress()

Simulate long press on an element.

await element(by.id('tappable')).longPress();

multiTap(times)

Simulate multiple taps on an element.

await element(by.id('tappable')).multiTap(3);

tapAtPoint()

Simulate tap at a specific point on an element.

Note: The point coordinates are relative to the matched element and the element size could changes on different devices or even when changing the device font size.

await element(by.id('tappable')).tapAtPoint({x:5, y:10});

typeText(text)

Use the builtin keyboard to type text into a text field.

await element(by.id('textField')).typeText('passcode');

Note: Make sure hardware keyboard is disconnected. Otherwise, Detox may fail when attempting to type text.

To make sure hardware keybaord is disconnected, open the simulator from Xcode and make sure Hardware -> Keyboard -> Connect Hardware Keyboard is deselected (or press ⇧⌘K).

replaceText(text)

Paste text into a text field.

await element(by.id('textField')).replaceText('passcode again');

clearText()

Clear text from a text field.

await element(by.id('textField')).clearText();

scroll(pixels, direction)

Scroll amount of pixels.
pixels - independent device pixels.
direction - left/right/top/bottom

await element(by.id('scrollView')).scroll(100, 'down');
await element(by.id('scrollView')).scroll(100, 'up');

scrollTo(edge)

Scroll to edge.

edge - left/right/top/bottom

await element(by.id('scrollView')).scrollTo('bottom');
await element(by.id('scrollView')).scrollTo('top');

swipe(direction, speed, percentage)

direction - left/right/up/down
speed - fast/slow - default is fast
percentage - (optional) screen percentage to swipe as float

await element(by.id('scrollView')).swipe('down');
await element(by.id('scrollView')).swipe('down', 'fast');
await element(by.id('scrollView')).swipe('down', 'fast', 0.5);

scrollDatePickerAtColumnToValue(column,value)

Scroll Date Picker at defined column to required value

await element(by.type('UIPickerView')).scrollDatePickerAtColumnToValue(0,'22');