{"id":25272017,"url":"https://github.com/gesielrosa/ionic-keyboard-assist","last_synced_at":"2025-07-07T03:08:56.471Z","repository":{"id":38569126,"uuid":"256639327","full_name":"gesielrosa/ionic-keyboard-assist","owner":"gesielrosa","description":"⌨️ This wizard corrects the bug when the keyboard overlaps/cover the screen and does not allow it to scroll.","archived":false,"fork":false,"pushed_at":"2023-01-07T17:12:50.000Z","size":1704,"stargazers_count":2,"open_issues_count":18,"forks_count":1,"subscribers_count":1,"default_branch":"production","last_synced_at":"2025-05-23T06:27:14.348Z","etag":null,"topics":["angular","ionic","library"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/ionic-keyboard-assist","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gesielrosa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-18T00:38:13.000Z","updated_at":"2022-09-12T12:26:50.000Z","dependencies_parsed_at":"2023-02-07T17:30:33.420Z","dependency_job_id":null,"html_url":"https://github.com/gesielrosa/ionic-keyboard-assist","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gesielrosa/ionic-keyboard-assist","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesielrosa%2Fionic-keyboard-assist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesielrosa%2Fionic-keyboard-assist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesielrosa%2Fionic-keyboard-assist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesielrosa%2Fionic-keyboard-assist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gesielrosa","download_url":"https://codeload.github.com/gesielrosa/ionic-keyboard-assist/tar.gz/refs/heads/production","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesielrosa%2Fionic-keyboard-assist/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261489612,"owners_count":23166470,"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":["angular","ionic","library"],"created_at":"2025-02-12T12:39:04.955Z","updated_at":"2025-07-07T03:08:56.454Z","avatar_url":"https://github.com/gesielrosa.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ionic-keyboard-assist\n\n![](https://img.shields.io/badge/me-%40gesiel.com-brightgreen)\n![](https://img.shields.io/npm/v/ionic-keyboard-assist?label=npm%40latest)\n![](https://img.shields.io/bundlephobia/minzip/ionic-keyboard-assist/latest)\n![](https://img.shields.io/npm/dm/ionic-keyboard-assist?label=npm%20downloads)\n![](https://img.shields.io/npm/l/ionic-keyboard-assist)\n![](https://img.shields.io/github/issues/gesielrosa/ionic-keyboard-assist)\n![](https://img.shields.io/github/stars/gesielrosa/ionic-keyboard-assist)\n![](https://img.shields.io/github/forks/gesielrosa/ionic-keyboard-assist)\n\nThis wizard corrects the bug when the keyboard overlaps/cover the screen and does not allow it to scroll. The user cannot see what is typing in the field.\n(Android 9 reported issue)\n\nIt is necessary \"cordova-plugin-ionic-keyboard\" plugin installed.\n- https://github.com/ionic-team/cordova-plugin-ionic-keyboard\n\n## Tested in versions:\nIonic: `@^4`\n\nKeyboard Plugin: `cordova-plugin-ionic-keyboard@^2.2.0`\n\niOS: `13`\n\nAndroid: `9`\n\n## Installation\n\nTo install the library:\n```\nnpm install ionic-keyboard-assist --save\n```\n\nAdd the service to your `app.module.ts` as a provider and set `scrollPadding` and `scrollAssist` to false:\n```\nimport { IonicKeyboardAssist } from 'ionic-keyboard-assist';\n\n@NgModule({\n  ...\n  IonicModule.forRoot({\n    scrollPadding: false,\n    scrollAssist: false\n  }),\n  ...\n  providers: [ IonicKeyboardAssist ],\n  ...\n})\nexport class AppModule { }\n```\n\nSet KeyboardResize plugin preference to false on `config.xml` (for iOS):\n[Read more](https://github.com/ionic-team/cordova-plugin-ionic-keyboard#keyboardresize-for-ios-only)\n\n```\n\u003cpreference name=\"KeyboardResize\" value=\"false\" /\u003e\n```\n\nThen, import and inject into the `app.component.ts` constructor and start the service:\n```\nimport { IonicKeyboardAssist } from 'ionic-keyboard-assist';\n\nconstructor(private keyboardAssist: IonicKeyboardAssist ) { \n  this.keyboardAssist.init();\n}\n```\n\n## Preferences\n\n### scrollPadding\n\n\u003e Boolean (true by default)\n\n#### Possible values\n- `true`: Add a `padding-bottom` to the screen the same size as the keyboard.\n- `false`: Does not change the screen padding.\n\n(Depending on the device, the `cordova-plugin-ionic-keyboard` calculates the wrong height)\n\n### scrollAssist\n\n\u003e Boolean (true by default)\n\n#### Possible values\n- `true`: Position the active/focused field in the center of the screen.\n- `false`: Does not give assistance to scroll.\n\n###### Set the configs\n```\n...\n  this.keyboardAssist.init({scrollPadding: true, scrollAssist: true});\n...\nor\n...\n  this.keyboardAssist.setOptions({scrollPadding: true, scrollAssist: true});\n...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgesielrosa%2Fionic-keyboard-assist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgesielrosa%2Fionic-keyboard-assist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgesielrosa%2Fionic-keyboard-assist/lists"}