This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Is Keyboard Shown

Whether or not the soft keyboard is shown

Example Usage

boolean isKeyboardShown = driver.isKeyboardShown();


// example

// wd example
await driver.isKeyboardShown();

# ruby_lib example

# ruby_lib_core example

// 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.3+ All All
Mac Mac None None None
Windows Windows 10+ 1.6.0+ All

Appium Clients

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

HTTP API Specifications


GET /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