Flick on the touch screen using finger motion events

Example Usage

// Java
TouchActions action = new TouchActions(driver);
action.flick(element, 1, 10, 10);

# Python
from appium.webdriver.common.touch_action import TouchAction
# ...
actions = TouchAction(driver)
actions.flick_element(element, 1, 10, 10)

// Javascript
// webdriver.io example
driver.touchFlick('<ELEMENT_ID>', 1, 10, 10);

// wd example
await element.flick(1, 10, 10);

# Ruby
# ruby_lib example
touch_action.flick(element, 1, 10, 10).perform

# ruby_lib_core example
@driver.touch_action.flick(element, 1, 10, 10).perform

// TODO PHP sample

// C#
// TODO C# sample


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 UiAutomator2 ?+ 1.6.0+ All
Espresso None None None
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


POST /session/:session_id/touch/flick

URL Parameters

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

JSON Parameters

name type description
element string ID of the element where the flick starts
xoffset number The x offset in pixels to flick by
yoffset number The y offset in pixels to flick by
speed number The speed in pixels per seconds



See Also