how to Detect if Keyboard is shown in Xcode UI test

Question

I am writing a UI text in swift under the new Xcode 7 UI test framework. the requirement is to test whether the system keyboard is shown in an app. can someone give me a clue on how to do that? thanks

BTW, when I was trying to look for the accessibility in the debug mode of the keyboard, I can't not see it in the app. so I guess that since it is a system keyboard, so we can not see it — user2823793, Jan 08 '16 at 19:45

Joris Timmerman · Answer 1 · 2016-05-04T10:05:35.907

32

Try this check:

let app = XCUIApplication()
XCTAssert(app.keyboards.count > 0, "The keyboard is not shown")

Or check for specific keyboard keys like:

let app = XCUIApplication()
XCTAssert(app.keyboards.buttons["Next:"].exists, "The keyboard has no Next button")

You can also control interactions on the keyboard:

let app = XCUIApplication()
app.keyboards.buttons["Next:"].tap()

edited May 04 '16 at 10:05

answered May 04 '16 at 09:32

Joris Timmerman

1,482
14
25

score 1 · Accepted Answer · answered Jan 08 '16 at 23:13

1

Add two observers

NSNotificationCenter.defaultCenter().addObserver(self, selector: "keyboardVisible:", name: UIKeyboardDidShowNotification, object: nil)
NSNotificationCenter.defaultCenter().addObserver(self, selector: "keyboardHidden:", name: UIKeyboardDidHideNotification, object: nil)

func keyboardVisible(notif: NSNotification) {
    print("keyboardVisible")
}

func keyboardHidden(notif: NSNotification) {
    print("keyboardHidden")
}

Whenever the keyboard is visible keyboardVisible will be called and whenever the keyboard is hidden keyboardHidden will be called.

answered Jan 08 '16 at 23:13

Rashwan L

38,237
7
103
107

I add this into the UI test code, but it does not work – user2823793 Jan 11 '16 at 15:25
2

here is my codeoverride `func setUp() { super.setUp() NSNotificationCenter.defaultCenter().addObserver(self, selector: "keyboardDidShow", name: UIKeyboardDidShowNotification, object: XCUIApplication()) }` – user2823793 Jan 11 '16 at 15:38
Should we use NotificationCenter in a UI Test? I doubt it. – Zhou Haibo Apr 14 '22 at 07:45

Charlie S · Answer 3 · 2021-01-10T11:26:53.473

0

I found the keyboard count check didnt work on one of my apps (it returned a count of 1 even when the keyboard was hidden), so amended it slightly:

private func isKeyboardShown() -> Bool {
    return XCUIApplication().keyboards.keys.count > 0
}

edited Jan 10 '21 at 11:26

answered May 06 '20 at 13:53

Charlie S

4,366
6
59
97

could you modify your answer above to read `private func...` instead of `private fund...`" – Professor Tom Jan 08 '21 at 19:26
`XCUIApplication().keyboards.element(boundBy: 0).exists` also works – Sentry.co Apr 15 '23 at 23:38

how to Detect if Keyboard is shown in Xcode UI test

3 Answers3