{"id":13801649,"url":"https://github.com/ionic-team/cordova-plugin-ionic-keyboard","last_synced_at":"2025-10-06T01:30:20.109Z","repository":{"id":37396658,"uuid":"90791742","full_name":"ionic-team/cordova-plugin-ionic-keyboard","owner":"ionic-team","description":"Keyboard Plugin for Cordova","archived":false,"fork":true,"pushed_at":"2023-09-28T19:28:58.000Z","size":246,"stargazers_count":192,"open_issues_count":74,"forks_count":178,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-01-18T21:58:27.516Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"cjpearson/cordova-plugin-keyboard","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ionic-team.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-09T21:04:48.000Z","updated_at":"2024-12-01T10:15:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ionic-team/cordova-plugin-ionic-keyboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionic-team%2Fcordova-plugin-ionic-keyboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionic-team%2Fcordova-plugin-ionic-keyboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionic-team%2Fcordova-plugin-ionic-keyboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionic-team%2Fcordova-plugin-ionic-keyboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ionic-team","download_url":"https://codeload.github.com/ionic-team/cordova-plugin-ionic-keyboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235469515,"owners_count":18995333,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T00:01:25.343Z","updated_at":"2025-10-06T01:30:14.753Z","avatar_url":"https://github.com/ionic-team.png","language":"Objective-C","readme":"# cordova-plugin-ionic-keyboard\n\nThis plugin has been designed to work seamlessly with `cordova-plugin-ionic-webview`, so make sure you have it installed first:\n\n - https://github.com/ionic-team/cordova-plugin-ionic-webview\n - https://ionicframework.com/docs/wkwebview/\n\n## Installation\n\n```\ncordova plugin add cordova-plugin-ionic-keyboard --save\n```\n\n## Preferences\n\n### KeyboardResize (for iOS only)\n\n\u003e Boolean (true by default)\n\n#### Possible values\n- `true`: Showing/hiding the keyboard will trigger some kind of resizing of the app (see KeyboardResizeMode)\n- `false`: Web will not be resized when the keyboard shows up.\n\n```xml\n\u003cpreference name=\"KeyboardResize\" value=\"true\" /\u003e\n```\n\n### KeyboardResizeMode (for iOS only)\n\n\u003e String ('native' by default)\n\n#### Possible values\n\n- `native`: The whole native webview will be resized when the keyboard shows/hides, it will affect the `vh` relative unit.\n- `body`: Only the html `\u003cbody\u003e` element will be resized. Relative units are not affected, because the viewport does not change.\n- `ionic`: Only the html `ion-app` element will be resized. Only for ionic apps.\n\n```xml\n\u003cpreference name=\"KeyboardResizeMode\" value=\"native\" /\u003e\n```\n\n### KeyboardStyle (for iOS only)\n\n\u003e String ('light' by default)\n\n#### Possible values\n\n- `light`\n- `dark`\n\n```xml\n\u003cpreference name=\"KeyboardStyle\" value=\"dark\" /\u003e\n```\n\n### HideKeyboardFormAccessoryBar (for iOS only)\n\n\u003e Boolean (true by default)\n\n#### Possible values\n- `true`: hides the keyboard accessory bar.\n- `false`: shows the keyboard accessory bar.\n\n```xml\n\u003cpreference name=\"HideKeyboardFormAccessoryBar\" value=\"false\" /\u003e\n```\n\n### resizeOnFullScreen (for Android only)\n\nThere is an Android bug that prevents the keyboard from resizing the WebView when the app is in full screen (i.e. if StatusBar plugin is used to hide the StatusBar). This setting, if set to true, add a workaround that resizes the WebView even when the app is in full screen.\n\n\u003e Boolean (false by default)\n\n#### Possible values\n- `false`: doesn't resize the WebView when the app is in full screen.\n- `true`: resizes the WebView when the app is in full screen.\n\n\n```xml\n\u003cpreference name=\"resizeOnFullScreen\" value=\"true\" /\u003e\n```\n\n\n## Methods\n\n### Keyboard.hideFormAccessoryBar (for iOS only)\n\n\u003e Hide the keyboard toolbar.\n\nSet to true to hide the additional toolbar that is on top of the keyboard. This toolbar features the Prev, Next, and Done buttons.\n\n```js\nKeyboard.hideFormAccessoryBar(value, successCallback);\n```\n\n#### Quick Example\n\n```js\nKeyboard.hideFormAccessoryBar(true);\nKeyboard.hideFormAccessoryBar(false);\nKeyboard.hideFormAccessoryBar(null, (currentValue) =\u003e { console.log(currentValue); });\n```\n\n### Keyboard.hide\n\n\u003e Hide the keyboard\n\nCall this method to hide the keyboard\n\n```js\nKeyboard.hide();\n```\n\n### Keyboard.show (for Android only)\n\n\u003e Show the keyboard\n\nCall this method to show the keyboard.\n\n```js\nKeyboard.show();\n```\n\n### Keyboard.setResizeMode (for iOS only)\n\n\u003e Programmatically set the resize mode\n\nCall the method with parameter to set the resize mode.\n\n```js\n// Possible values are the same as for 'KeyboardResizeMode' preference\nKeyboard.setResizeMode('native');\nKeyboard.setResizeMode('body');\nKeyboard.setResizeMode('ionic');\n```\n\n### Keyboard.setKeyboardStyle (for iOS only)\n\n\u003e Programmatically set the keyboard style\n\n```js\n// Possible values are the same as for 'KeyboardStyle' preference\nKeyboard.setKeyboardStyle('light'); // \u003c- default\nKeyboard.setKeyboardStyle('dark');\n```\n\n### Keyboard.disableScroll (for iOS only)\n\n\u003e Programmatically enable or disable the WebView scroll\n\n```js\nKeyboard.disableScroll(true); // \u003c- default\nKeyboard.disableScroll(false);\n```\n\n\n## Properties\n\n### Keyboard.isVisible\n\n\u003e Determine if the keyboard is visible.\n\nRead this property to determine if the keyboard is visible.\n\n```js\nif (Keyboard.isVisible) {\n    // do something\n}\n```\n\n## Events\n\n### keyboardDidHide\n\n\u003e This event is fired when the keyboard is fully closed.\n\nAttach handler to this event to be able to receive notification when keyboard is closed.\n\n```js\nwindow.addEventListener('keyboardDidHide', () =\u003e {\n    // Describe your logic which will be run each time keyboard is closed.\n});\n```\n\n### keyboardDidShow\n\n\u003e This event is fired when the keyboard is fully open.\n\nAttach handler to this event to be able to receive notification when keyboard is opened.\n\n```js\nwindow.addEventListener('keyboardDidShow', (event) =\u003e {\n    // Describe your logic which will be run each time when keyboard is about to be shown.\n    console.log(event.keyboardHeight);\n});\n```\n\n### keyboardWillShow\n\n\u003e This event fires before keyboard will be shown.\n\nAttach handler to this event to be able to receive notification when keyboard is about to be shown on the screen.\n\n```js\nwindow.addEventListener('keyboardWillShow', (event) =\u003e {\n    // Describe your logic which will be run each time when keyboard is about to be shown.\n    console.log(event.keyboardHeight);\n});\n```\n\n### keyboardWillHide\n\n\u003e This event fires before keyboard will be closed.\n\nAttach handler to this event to be able to receive notification when keyboard is about to be closed.\n\n```js\nwindow.addEventListener('keyboardWillHide', () =\u003e {\n    // Describe your logic which will be run each time when keyboard is about to be closed.\n});\n```\n","funding_links":[],"categories":["Cordova plugins"],"sub_categories":["Incompatible"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fionic-team%2Fcordova-plugin-ionic-keyboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fionic-team%2Fcordova-plugin-ionic-keyboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fionic-team%2Fcordova-plugin-ionic-keyboard/lists"}