Unlock 30% off on Manual Testing Annual Plans this Holiday Season. 
Use Code: LCMYEARENDEXCL30
Use Code: LCMYEARENDEXCL30Check icon
Copied to Clipboard!
How to use driver.hideKeyboard method in Appium Xcuitest Driver
Best JavaScript code snippet using appium-xcuitest-driver
LoginScreen.js
Source:LoginScreen.js 
...15 await this.email.setValue(username);16 await this.password.setValue(password);17 if (await browser.isKeyboardShown()) {18 /**19 * Normally we would hide the keyboard with this command `driver.hideKeyboard()`, but there is an issue for hiding the keyboard20 * on iOS when using the command. You will get an error like below21 *22 * Request failed with status 400 due to Error Domain=com.facebook.WebDriverAgent Code=1 "The keyboard on iPhone cannot be23 * dismissed because of a known XCTest issue. Try to dismiss it in the way supported by your application under test."24 * UserInfo={NSLocalizedDescription=The keyboard on iPhone cannot be dismissed because of a known XCTest issue. Try to dismiss25 * it in the way supported by your application under test.}26 *27 * That's why we click outside of the keyboard.28 */29 await $('~Login-screen').click();30 }31 // On smaller screens there could be a possibility that the login button is not shown32 // Gestures.checkIfDisplayedWithSwipeUp(this.loginButton, 2);33 await this.loginButton.click();34 }35 async submitSignUpForm(username, password) {36 await this.email.setValue(username);37 await this.password.setValue(password);38 await this.repeatPassword.setValue(password);39 if (await browser.isKeyboardShown()) {40 /**41 * Normally we would hide the keyboard with this command `driver.hideKeyboard()`, but there is an issue for hiding the keyboard42 * on iOS when using the command. You will get an error like below43 *44 * Request failed with status 400 due to Error Domain=com.facebook.WebDriverAgent Code=1 "The keyboard on iPhone cannot be45 * dismissed because of a known XCTest issue. Try to dismiss it in the way supported by your application under test."46 * UserInfo={NSLocalizedDescription=The keyboard on iPhone cannot be dismissed because of a known XCTest issue. Try to dismiss47 * it in the way supported by your application under test.}48 *49 * That's why we click outside of the keyboard.50 */51 await $('~Login-screen').click();52 }53 // On smaller screens there could be a possibility that the button is not shown54 // Gestures.checkIfDisplayedWithSwipeUp(this.signUpButton, 2);55 await this.signUpButton.click();...
clear-specs.js
Source:clear-specs.js
...17 let el1 = await driver.findElement('class name', 'UIATextField');18 await driver.setValue("1", el1);19 let el2 = await driver.findElement('class name', 'UIASwitch');20 (await driver.elementDisplayed(el2)).should.not.be.ok;21 await driver.hideKeyboard(undefined, "Done", driver.sessionId);22 (await driver.elementDisplayed(el2)).should.be.ok;23 });24 it('should hide keyboard using "pressKey" strategy with "Done" key', async function () {25 let el1 = await driver.findElement('class name', 'UIATextField');26 await driver.setValue("1", el1);27 let el2 = await driver.findElement('class name', 'UIASwitch');28 (await driver.elementDisplayed(el2)).should.not.be.ok;29 await driver.hideKeyboard('pressKey', "Done", driver.sessionId);30 (await driver.elementDisplayed(el2)).should.be.ok;31 });32 it('should hide keyboard using "pressKey" strategy with "Done" keyName', async function () {33 let el1 = await driver.findElement('class name', 'UIATextField');34 await driver.setValue("1", el1);35 let el2 = await driver.findElement('class name', 'UIASwitch');36 (await driver.elementDisplayed(el2)).should.not.be.ok;37 await driver.hideKeyboard('pressKey', undefined, undefined, "Done", driver.sessionId);38 (await driver.elementDisplayed(el2)).should.be.ok;39 });40 it('should hide keyboard using "press" strategy with "Done" key', async function () {41 let el1 = await driver.findElement('class name', 'UIATextField');42 await driver.setValue("1", el1);43 let el2 = await driver.findElement('class name', 'UIASwitch');44 (await driver.elementDisplayed(el2)).should.not.be.ok;45 await driver.hideKeyboard('press', "Done", driver.sessionId);46 (await driver.elementDisplayed(el2)).should.be.ok;47 });48 // swipedown just doesn't work with testapp49 it.skip('should hide keyboard using "swipeDown" strategy', async function () {50 let el1 = await driver.findElement('class name', 'UIATextField');51 await driver.setValue("1", el1);52 let el2 = await driver.findElement('class name', 'UIASwitch');53 (await driver.elementDisplayed(el2)).should.not.be.ok;54 await driver.hideKeyboard('swipeDown', driver.sessionId);55 (await driver.elementDisplayed(el2)).should.be.ok;56 });...
app.register.spec.js
Source:app.register.spec.js
...15 $('~input-email').setValue('hi@test.de');16 $('~input-password').setValue('Test1234!');17 $('~input-repeat-password').setValue('Test1234!');18 if (driver.isKeyboardShown()) {19 driver.hideKeyboard();20 }21 /*SIGN UP button is in LoginForm.js, selector defined in login.screen.js*/22 $('~button-SIGN UP').click();23 NativeAlert.waitForIsShown();24 expect(NativeAlert.text()).toEqual('Signed Up!\nYou successfully signed up!');25 NativeAlert.pressButton('OK');26 NativeAlert.waitForIsShown(false);27 });28});29/*Same tests in abstract form, these tests were30already included in the boilerplate code (https://github.com/webdriverio/appium-boilerplate/tree/master/tests/specs)31describe('WebdriverIO and Appium, when interacting with a login form,', () => {32 beforeEach(() => {33 TabBar.waitForTabBarShown(true);34 TabBar.openLogin();35 LoginScreen.waitForIsShown(true);36 });37 it('should be able sign up successfully', () => {38 LoginScreen.signUpContainerButon.click();39 LoginScreen.email.setValue('hi@test.de');40 LoginScreen.password.setValue('Test1234!');41 LoginScreen.repeatPassword.setValue('Test1234!');42 if (driver.isKeyboardShown()) {43 driver.hideKeyboard();44 }45 LoginScreen.signUpButton.click();46 LoginScreen.alert.waitForIsShown();47 expect(LoginScreen.alert.text()).toEqual('Signed Up!\nYou successfully signed up!');48 LoginScreen.alert.pressButton('OK');49 LoginScreen.alert.waitForIsShown(false);50 });...
TabTwoScreen.spec.js
Source:TabTwoScreen.spec.js
...32test("Email input test", async () => {33 const loginEmailInput = await driver.$("~emailInput");34 await loginEmailInput.clearValue();35 await loginEmailInput.setValue("TestAccount@test.com");36 await driver.hideKeyboard("pressKey", "return");37 const text = await loginEmailInput.getText();38 expect(text).toBe("TestAccount@test.com");39});40test("Password input test", async () => {41 const loginPasswordInput = await driver.$("~passwordInput");42 await loginPasswordInput.clearValue();43 await loginPasswordInput.setValue("Password");44 await driver.hideKeyboard("pressKey", "return");45 const text = await loginPasswordInput.getText();46 expect(text).toBe("â¢â¢â¢â¢â¢â¢â¢â¢");47});48test("button click test", async () => {49 const LoginButton = await driver.$("~LoginButton");50 LoginButton.click();51 await driver.pause(3000);52 let popUp = await driver.$("~popUp");53 let isDisplayed = await popUp.isDisplayed();54 expect(isDisplayed).toBe(true);55 await driver.pause(500);56 LoginButton.click();57 await driver.pause(2000);58 isDisplayed = await popUp.isDisplayed();...
login.steps.js
Source:login.steps.js
...18 const tableRows = table.hashes();19 for (const element of tableRows) {20 await LoginPage.txtUsername_setText(element.Username);21 await LoginPage.txtPassword_setText(element.Password);22 await driver.hideKeyboard('pressKey', 'return');23 await LoginPage.clickLogin();24 //await browser.setTimeout({'implicit': 5000})25 //const alertText = await browser.getAlertText();26 //await expect(browser.getAlertText()).toHaveText(element.ErrorMessage)27 //expect(alertText == await element.ErrorMessage);28 expect(`~${await element.ErrorMessage}`).toBeExisting();29 await LoginPage.AlertBtnOk.click();30 //await browser.acceptAlert();31 }32});33When(/^I enter valid credentials, accept terms and tap Sign In$/, async (table) => {34 const tableRows = table.hashes();35 for (const element of tableRows) {36 //await LoginPage.chkbxTerms_tap();37 await LoginPage.txtUsername_setText(element.Username);38 await LoginPage.txtPassword_setText(element.Password);39 await driver.hideKeyboard('pressKey', 'return');40 await LoginPage.clickLogin();41 }42});43Then(/^I should be on the MFA Screen$/, async () => {44 await expect(SelectMFAPage.txtMFAScreen).toHaveText('Select a method below to verify your identity')...
signUp-test.js
Source:signUp-test.js
...19 SignUp.password.setValue("");20 SignUp.confirmPassword.setValue("");21 22 if (driver.isKeyboardShown()) {23 driver.hideKeyboard();24 }25 SignUp.signupButton.click();26 27 const failureValue = SignUp.failureAlert.getText();28 SignUp.tryAgainButton("Try again");29 const emailValidate = SignUp.validEmail.getText();30 const passwordValidate = SignUp.validPassword.getText();31 const confPasswordValidate = SignUp.vaildConfirmPassword.getText();32 33 expect(failureValue).to.equal(failureText);34 expect(emailValidate).to.equal(validateEmailText);35 expect(passwordValidate).to.equal(validatePasswordText);36 expect(confPasswordValidate).to.equal(validateconfPassText);37 });38 it("should show alert and get validation message when confirm password is not entered", function () {39 const failureText = "Failure";40 const validateconfPassText = "Please enter the same password";41 42 SignUp.email.setValue("test@webdriver.io");43 SignUp.password.setValue("Test1234!");44 SignUp.confirmPassword.setValue("");45 if (driver.isKeyboardShown()) {46 driver.hideKeyboard();47 }48 SignUp.signupButton.click();49 50 const failureValue = SignUp.failureAlert.getText();51 SignUp.tryAgainButton("Try again");52 53 const confPasswordValidate = SignUp.vaildConfirmPassword.getText();54 expect(failureValue).to.equal(failureText);55 expect(confPasswordValidate).to.equal(validateconfPassText);56 });57})58`;...
app.home.spec.js
Source:app.home.spec.js
...25 action: 'release',26 },27 ]);28 if (driver.isKeyboardShown()) {29 driver.hideKeyboard();30 }31 expect(HomeScreen.searchButton.isExisting()).toEqual(true);32 HomeScreen.searchButton.click();33 });34 it('click takes you to enquire screen', () => {35 Gestures.checkIfDisplayedWithScrollDown(SearchScreen.enquireButton, 2);36 expect(SearchScreen.enquireButton.isExisting()).toEqual(true);37 SearchScreen.enquireButton.click();38 if (driver.isKeyboardShown()) {39 driver.hideKeyboard();40 }41 });42 it('should be able to click Send Enquiry and fail successfully', () => {43 EnquiryScreen.sendEnquiryButton.click();44 if (driver.isKeyboardShown()) {45 driver.hideKeyboard();46 }47 EnquiryScreen.alert.waitForIsShown(true);48 //expect an alert49 //expect(EnquiryScreen.alert.isExisting()).toEqual(true);50 });...
RepeatScreen.js
Source:RepeatScreen.js
...13 super(SELECTORS.REPEAT_CUSTOM_SCREEN);14 }15 pressEveryRepeatDaily() {16 if (driver.isKeyboardShown()) {17 driver.hideKeyboard();18 }19 this.click(SELECTORS.REPEAT_FREQUENCY_DAILY);20 }21 pressEveryRepeatWeekly() {22 if (driver.isKeyboardShown()) {23 driver.hideKeyboard();24 }25 this.click(SELECTORS.REPEAT_FREQUENCY_WEEKLY);26 }27 pressEveryRepeatMonths() {28 if (driver.isKeyboardShown()) {29 driver.hideKeyboard();30 }31 this.click(SELECTORS.REPEAT_FREQUENCY_MONTH);32 }33}...
Using AI Code Generation
1const wd = require('wd');2(async () => {3 await driver.init({4 });5 await driver.setImplicitWaitTimeout(10000);6 await driver.hideKeyboard();7})();8Error: The desiredCapabilities object was not valid for the following reason(s): app must be set9const wd = require('wd');10(async () => {11 await driver.init({12 });13 await driver.setImplicitWaitTimeout(10000);14 await driver.hideKeyboard();15})();16const wd = require('wd');17(async () => {18 await driver.init({19 });20 await driver.setImplicitWaitTimeout(10000);21 await driver.hideKeyboard();22})();
Using AI Code Generation
1const { remote } = require('webdriverio');2(async () => {3 const browser = await remote({4 capabilities: {5 }6 })7})();8const { remote } = require('webdriverio');9(async () => {10 const browser = await remote({11 capabilities: {12 }13 })14 await browser.$('~button').click();15 await browser.$('~textField').setValue('Hello World');16 await browser.hideKeyboard();17})();18const { remote } = require('webdriverio');19(async () => {20 const browser = await remote({21 capabilities: {22 }23 })24 await browser.$('~button').click();25 await browser.$('~textField').setValue('Hello World');26 await browser.hideKeyboard('pressKey', 'Done');27})();28const { remote } = require
Using AI Code Generation
1var webdriverio = require('webdriverio');2var options = {3 desiredCapabilities: {4 }5};6 .remote(options)7 .init()8 .hideKeyboard()9 .end();10driver.hideKeyboard('pressKey', 'Done')11driver.hideKeyboard();12Driver.hideKeyboard(strategy, key)13Driver.hideKeyboard(strategy, key, elementId)14Driver.hideKeyboard(strategy, key, elementId, keyCode)15Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode)16Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode, metastate)17Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode, metastate, flags)18Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode, metastate, flags, appPackage)19Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode, metastate, flags, appPackage, appActivity)20Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode, metastate, flags, appPackage, appActivity, replaceValue)21Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode, metastate, flags, appPackage, appActivity, replaceValue, keyName)22Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode, metastate, flags, appPackage, appActivity, replaceValue, keyName, element)23Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode, metastate, flags, appPackage, appActivity, replaceValue, keyName, element, unicodeKeyboard)24Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode, metastate, flags, appPackage, appActivity, replaceValue, keyName, element, unicodeKeyboard, resetKeyboard)25Driver.hideKeyboard(strategy, key, elementId, keyCode, unicode, metastate, flags, appPackage, appActivity, replaceValue,
Using AI Code Generation
1var webdriverio = require('webdriverio');2var options = {3 desiredCapabilities: {4 }5};6 .remote(options)7 .init()8 .element('accessibility id', 'username')9 .setValue('user')10 .element('accessibility id', 'password')11 .setValue('pass')12 .hideKeyboard()13 .end();14var webdriverio = require('webdriverio');15var options = {16 desiredCapabilities: {17 }18};19 .remote(options)20 .init()21 .element('accessibility id', 'username')22 .setValue('user')23 .element('accessibility id', 'password')24 .setValue('pass')25 .hideKeyboard()26 .end();27var webdriverio = require('webdriverio');28var options = {29 desiredCapabilities: {30 }31};32 .remote(options)33 .init()34 .element('accessibility id', 'username')35 .setValue('user')36 .element('accessibility id', 'password')37 .setValue('pass')38 .hideKeyboard('pressKey', 'Done')39 .end();
Using AI Code Generation
1var webdriverio = require('webdriverio');2var opts = {3 desiredCapabilities: {4 }5};6 .remote(opts)7 .init()8 .setValue('xpath', 'value')9 .hideKeyboard()10 .end();11var webdriverio = require('webdriverio');12var opts = {13 desiredCapabilities: {14 }15};16 .remote(opts)17 .init()18 .setValue('xpath', 'value')19 .hideKeyboard()20 .end();21var webdriverio = require('webdriverio');22var opts = {23 desiredCapabilities: {24 }25};26 .remote(opts)27 .init()28 .setValue('xpath', 'value')29 .hideKeyboard()30 .end();31var webdriverio = require('webdriverio');32var opts = {33 desiredCapabilities: {34 }35};36 .remote(opts)37 .init()38 .setValue('xpath', 'value')39 .hideKeyboard()40 .end();
Using AI Code Generation
1driver.hideKeyboard();2driver.hideKeyboard('Done', 'pressKey')3driver.hideKeyboard('Done', 'pressKey')4driver.hideKeyboard('Done', 'pressKey')5driver.hideKeyboard('Done', 'pressKey')6driver.hideKeyboard('Done', 'pressKey')7driver.hideKeyboard('Done', 'pressKey')8driver.hideKeyboard('Done', 'pressKey')9driver.hideKeyboard('Done', 'pressKey')10driver.hideKeyboard('Done', 'pressKey')11driver.hideKeyboard('Done', 'pressKey')12driver.hideKeyboard('Done', 'pressKey')13driver.hideKeyboard('Done', 'pressKey')14driver.hideKeyboard('Done', 'pressKey')15driver.hideKeyboard('Done', 'pressKey')16driver.hideKeyboard('Done', 'pressKey')17driver.hideKeyboard('Done', 'pressKey')18driver.hideKeyboard('Done', 'pressKey')19driver.hideKeyboard('Done', 'pressKey')20driver.hideKeyboard('Done', 'pressKey')21driver.hideKeyboard('Done', 'pressKey
Using AI Code Generation
1driver.hideKeyboard()2driver.hideKeyboard('Done')3driver.hideKeyboard('Done', 'return')4driver.hideKeyboard('Done', 'return', 'Return')5driver.hideKeyboard('Done', 'return', 'Return', 'Go')6driver.hideKeyboard('Done', 'return', 'Return', 'Go', 'Search')7driver.hideKeyboard('Done', 'return', 'Return', 'Go', 'Search', 'Join')8driver.hideKeyboard('Done', 'return', 'Return', 'Go', 'Search', 'Join', 'Next')9driver.hideKeyboard('Done', 'return', 'Return', 'Go', 'Search', 'Join', 'Next', 'Send')10driver.hideKeyboard('Done', 'return', 'Return', 'Go', 'Search', 'Join', 'Next', 'Send', 'Route')11driver.hideKeyboard('Done', 'return', 'Return', 'Go', 'Search', 'Join', 'Next', 'Send', 'Route', 'Emergency Call')12driver.hideKeyboard('Done', 'return', 'Return',
Automation Testing Tutorials
Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.
LambdaTest Learning Hubs:
- JUnit Tutorial
- TestNG Tutorial
- Webdriver Tutorial
- WebDriverIO Tutorial
- Protractor Tutorial
- Selenium 4 Tutorial
- Jenkins Tutorial
- NUnit Tutorial
- Jest Tutorial
- Playwright Tutorial
- Cypress Tutorial
- PyTest Tutorial
YouTube
You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.
Try LambdaTest Now !!
Get 100 minutes of automation test minutes FREE!!
Was this article helpful?
