Skip to content

Commit 9ce7edd

Browse files
wswebcreationwswebcreation
authored
chore: update mobile docs (#14424)
1 parent e5cf99f commit 9ce7edd

File tree

7 files changed

+58
-0
lines changed

7 files changed

+58
-0
lines changed

‎packages/webdriverio/src/commands/mobile/dragAndDrop.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@
1010
*
1111
* Also make sure that the element you are dragging and the target where you are dropping are both visible on the screen.
1212
*
13+
* This command only works with the following up-to-date components:
14+
* - Appium server (version 2.0.0 or higher)
15+
* - `appium-uiautomator2-driver` (for Android)
16+
* - `appium-xcuitest-driver` (for iOS)
17+
*
18+
* Make sure your local or cloud-based Appium environment is regularly updated to avoid compatibility issues.
19+
*
1320
* :::
1421
*
1522
* <example>

‎packages/webdriverio/src/commands/mobile/longPress.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ import type { LongPressOptions } from '../../types.js'
77
*
88
* This issues a WebDriver `action` command for the selected element. It is based on the `click` command.
99
*
10+
* :::info
11+
*
12+
* This command only works with the following up-to-date components:
13+
* - Appium server (version 2.0.0 or higher)
14+
* - `appium-uiautomator2-driver` (for Android)
15+
* - `appium-xcuitest-driver` (for iOS)
16+
*
17+
* Make sure your local or cloud-based Appium environment is regularly updated to avoid compatibility issues.
18+
*
19+
* :::
20+
*
1021
* <example>
1122
:longpress.offset.js
1223
it('should demonstrate a longPress using an offset on the iOS Contacts icon', async () => {

‎packages/webdriverio/src/commands/mobile/pinch.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ import { calculateAndroidPinchAndZoomSpeed, validatePinchAndZoomOptions } from '
1212
* - [appium-uiautomator2-driver](https://github.com/appium/appium-uiautomator2-driver/blob/master/docs/android-mobile-gestures.md#mobile-pinchclosegesture) for Android
1313
* - [appium-xcuitest-driver](https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-pinch) for iOS
1414
*
15+
* This command only works with the following up-to-date components:
16+
* - Appium server (version 2.0.0 or higher)
17+
* - `appium-uiautomator2-driver` (for Android)
18+
* - `appium-xcuitest-driver` (for iOS)
19+
*
20+
* Make sure your local or cloud-based Appium environment is regularly updated to avoid compatibility issues.
21+
*
1522
* :::
1623
*
1724
* <example>

‎packages/webdriverio/src/commands/mobile/scrollIntoView.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@
66
*
77
* Scrolling for Mobile Native Apps is done based on the mobile `swipe` command.
88
*
9+
* This command only works with the following up-to-date components:
10+
* - Appium server (version 2.0.0 or higher)
11+
* - `appium-uiautomator2-driver` (for Android)
12+
* - `appium-xcuitest-driver` (for iOS)
13+
*
14+
* Make sure your local or cloud-based Appium environment is regularly updated to avoid compatibility issues.
15+
*
916
* :::
1017
*
1118
* <example>

‎packages/webdriverio/src/commands/mobile/swipe.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ const SWIPE_DEFAULTS = {
2121
* or [`mobile: scroll`](https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-scroll) for iOS command which is based on the Appium Driver protocol and is
2222
* only available for mobile platforms in the NATIVE context.
2323
*
24+
* This command only works with the following up-to-date components:
25+
* - Appium server (version 2.0.0 or higher)
26+
* - `appium-uiautomator2-driver` (for Android)
27+
* - `appium-xcuitest-driver` (for iOS)
28+
*
29+
* Make sure your local or cloud-based Appium environment is regularly updated to avoid compatibility issues.
30+
*
2431
* :::
2532
*
2633
* :::caution Swiping based on coordinates

‎packages/webdriverio/src/commands/mobile/tap.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ const log = logger('webdriver')
2626
* For Native Apps, this command differs from the `click` command as it will <strong>automatically swipe</strong> to the element using the `scrollIntoView command`,
2727
* which is not supported for native apps with the `click` command. In hybrid apps or web environments, automatic scrolling is supported for both `click` and `tap` commands.
2828
*
29+
* :::info
30+
*
31+
* This command only works with the following up-to-date components:
32+
* - Appium server (version 2.0.0 or higher)
33+
* - `appium-uiautomator2-driver` (for Android)
34+
* - `appium-xcuitest-driver` (for iOS)
35+
*
36+
* Make sure your local or cloud-based Appium environment is regularly updated to avoid compatibility issues.
37+
*
38+
* :::
39+
*
40+
*
2941
* :::caution For Screen taps
3042
*
3143
* If you want to tap on a specific coordinate on the screen and you use a screenshot to determine the coordinates, remember that the

‎packages/webdriverio/src/commands/mobile/zoom.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ import { calculateAndroidPinchAndZoomSpeed, validatePinchAndZoomOptions } from '
1212
* - [appium-uiautomator2-driver](https://github.com/appium/appium-uiautomator2-driver/blob/master/docs/android-mobile-gestures.md#mobile-pinchopengesture) for Android
1313
* - [appium-xcuitest-driver](https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-pinch) for iOS
1414
*
15+
* This command only works with the following up-to-date components:
16+
* - Appium server (version 2.0.0 or higher)
17+
* - `appium-uiautomator2-driver` (for Android)
18+
* - `appium-xcuitest-driver` (for iOS)
19+
*
20+
* Make sure your local or cloud-based Appium environment is regularly updated to avoid compatibility issues.
21+
*
1522
* :::
1623
*
1724
* <example>

0 commit comments

Comments
 (0)