Scroll

Scroll on the touch screen using finger based motion events

Example Usage

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


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


// Javascript
// webdriver.io example
driver.touchScroll({
  el: element,
  xOffset: 10,
  yOffset: 100
});



[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
// wd example
await driver.scroll(10, 100);


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


[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
# ruby_lib_core example
@driver.touch_action.scroll(element, 10, 100).perform


# PHP
// TODO PHP sample


// C#
// TODO C# sample

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.2+ 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 seleniumhq.github.io
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby All www.rubydoc.info
PHP All github.com
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