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

  Edit this Doc Scroll

Scroll on the touch screen using finger based motion events

Example Usage

TouchActions action = new TouchActions(driver);
action.scroll(element, 10, 100);
action.perform();

from appium.webdriver.common.touch_action import TouchAction
# ...
actions = TouchAction(driver)
actions.scroll_from_element(element, 10, 100)
actions.scroll(10, 100)
actions.perform()

// webdriver.io example
driver.touchScroll(10, 100, element);

// wd example
await driver.scroll(10, 100);

# ruby_lib example
touch_actions.scroll(element, 10, 100).perform

# ruby_lib_core example
@driver.touch_actions.scroll(element, 10, 100).perform

TouchActions action = new TouchActions(driver);
action.Scroll(element, 10, 100);
action.Perform();

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

POST /session/:session_id/touch/scroll

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

name type description
x number X coordinate on the screen
y number Y coordinate on the screen

Response

null

See Also