Is Keyboard Shown

Whether or not the soft keyboard is shown

Example Usage

// Java
boolean isKeyboardShown = driver.isKeyboardShown();

# Not supported
// Not supported

// wd example
await driver.isKeyboardShown();

# Ruby
# ruby_lib example

# ruby_lib_core example

// Not supported
// Not supported


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 Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.2+ All All
Mac Mac None None None
Windows Windows 10+ 1.6.0+ All

Appium Clients

Language Support Documentation
Java All
Python None
Javascript (WebdriverIO) None
Javascript (WD) All
Ruby All
PHP None
C# None

HTTP API Specifications


GET /wd/hub/session/:session_id/appium/device/is_keyboard_shown

URL Parameters

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

JSON Parameters



True if the keyboard is shown. (boolean)

See Also