टैप

Performs a tap gesture on:

• or the given element. It will automatically scroll if it can't be found.
• or the screen on a mobile device by providing x and y coordinates

Internally it uses:

• Element tap:
  • the click command for Web environments (Chrome/Safari browsers, or hybrid apps)
  • the Android mobile: clickGesture or iOS mobile: tap for Natives apps, including the scrollIntoView command for automatic scrolling
• Screen tap:
  • the action command for Web environments (Chrome/Safari browsers, or hybrid apps)
  • the Android mobile: clickGesture or iOS mobile: tap for Natives apps

This difference makes the tap command a more reliable alternative to the click command for mobile apps.

For Native Apps, this command differs from the click command as it will automatically swipe to the element using the scrollIntoView command, 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.

जानकारी

This command only works with the following up-to-date components:

• Appium server (version 2.0.0 or higher)
• appium-uiautomator2-driver (for Android)
• appium-xcuitest-driver (for iOS)

Make sure your local or cloud-based Appium environment is regularly updated to avoid compatibility issues.

For Screen taps

If you want to tap on a specific coordinate on the screen and you use a screenshot to determine the coordinates, remember that the the coordinates for iOS are based on the device's screen size, and not the screenshot size. The screenshot size is larger due to the device pixel ratio. The average device pixel ratio until the iPhone 8 and the current iPads is 2, for iPhones from the iPhone X the ratio is 3. This means that the screenshot size is 2 or 3 times larger than the device's screen size which means that ff you find the coordinates on the screenshot, divide them by the device pixel ratio to get the correct screen coordinates. For example:

const screenshotCoordinates = { x: 600, y: 900 };
const dpr = 3; // Example for iPhone 16
const screenCoordinates = {
    x: screenshotCoordinates.x / dpr,
    y: screenshotCoordinates.y / dpr
};
await browser.tap(screenCoordinates);

Parameters

Name	Type	Details
options optional	TapOptions	टैप विकल्प (वैकल्पिक)
Element tap options
options.x optional	number	संख्या (वैकल्पिक, अनिवार्य यदि y सेट है) केवल स्क्रीन टैप के लिए, एलिमेंट टैप के लिए नहीं
options.y optional	number	संख्या (वैकल्पिक, अनिवार्य यदि x सेट है) केवल स्क्रीन टैप के लिए, एलिमेंट टैप के लिए नहीं
Screen tap options
options.direction optional	string	down, up, left या right में से एक हो सकता है, डिफ़ॉल्ट down है। केवल एलिमेंट टैप के लिए, स्क्रीन टैप के लिए नहीं केवल-मोबाइल-नेटिव-ऐप
options.maxScrolls optional	number	स्क्रॉल की अधिकतम मात्रा जब तक यह एलिमेंट की खोज बंद कर देगा, डिफ़ॉल्ट 10 है। केवल एलिमेंट टैप के लिए, स्क्रीन टैप के लिए नहीं केवल-मोबाइल-नेटिव-ऐप
options.scrollableElement optional	Element	वह एलिमेंट जिसके भीतर स्क्रॉल करने के लिए उपयोग किया जाता है। यदि कोई एलिमेंट प्रदान नहीं किया जाता है तो यह iOS के लिए -ios predicate string:type == "XCUIElementTypeApplication" और Android के लिए //android.widget.ScrollView' सेलेक्टर का उपयोग करेगा। यदि डिफ़ॉल्ट सेलेक्टर से अधिक एलिमेंट मेल खाते हैं, तो डिफ़ॉल्ट रूप से यह पहले मिलने वाले एलिमेंट को चुनेगा। केवल एलिमेंट टैप के लिए, स्क्रीन टैप के लिए नहीं केवल-मोबाइल-नेटिव-ऐप

Examples

element.tap.example.js

it('should be able to tap an on element', async () => {
    const elem = $('~myElement')
    // It will automatically scroll to the element if it's not already in the viewport
    await elem.tap()
})

element.tap.scroll.options.example.js

it('should be able to swipe right 3 times in a custom scroll areas to an element and tap on the element', async () => {
    const elem = $('~myElement')
    // Swipe right 3 times in the custom scrollable element to find the element
    await elem.tap({
        direction: 'right',
        maxScrolls: 3,
        scrollableElement: $('#scrollable')
    })
})

screen.tap.example.js

it('should be able to tap on screen coordinates', async () => {
    await browser.tap({ x: 200, y: 400 })
})