fix(android): Apply bottom insets to system keyboard by darcywong00 · Pull Request #14808 · keymanapp/keyman

darcywong00 · 2025-09-22T06:37:43Z

Fixes #14794 and follows #14619

~~This should create test builds that @ermshiperete and I can try on our devices to troubleshoot.~~

This updates SystemKeyboard to adjust the padding and offsets for the navigation bar height.

TODO:

separate PR to update Sample and FirstVoices 🔗 fix(android): Fix bottom insets for Sample and FirstVoices apps #14828

User Testing

Setup - Install the PR build of Keyman for Android. Set Keyman as the default system keyboard. Also on the device Settings, configure the bottom navigation to use the 3-button bar instead of gestures. Use the Android API level per the Group name

GROUP_API_31 - Use Android API 31 on the device/emulator

GROUP_API_34 - Use Android API 34 on the device/emulator

GROUP_API_35 - Use Android API 35 on the device/emulator

TEST_OSK - Verifies Keyman system keyboard is connected to the bottom navigation bar and not covered

Launch Keyman and dismiss the Get Started menu
Verify the in-app keyboard functions
a. base keys
b. longpress keys
c. suggestion banner
Force-quit Keyman in the system settings
Launch Chrome and select a text area to type in
Select a non-Keyman system keyboard
Select the Keyman system keyboard
Verify the Keyman OSK is not covered by the bottom navigation bar
Verify there's no gap between the Keyman OSK and the bottom navigation bar
Verify the Keyman system keyboard functions
a. base keys
b. longpress keys
c. suggestion banner
Launch Keyman
Return to Chrome and select a text area to type in
Verify the Keyman OSK is not covered by the bottom navigation bar
Verify there's no gap between the Keyman OSK and the bottom navigation bar

keymanapp-test-bot · 2025-09-22T06:38:10Z

User Test Results

Test specification and instructions

✅ GROUP_API_31: - Use Android API 31 on the device/emulator
1 tests PASSED
- ✅ TEST_OSK (PASSED) (notes)
✅ GROUP_API_34: - Use Android API 34 on the device/emulator
1 tests PASSED
- ✅ TEST_OSK (PASSED) (notes)
✅ GROUP_API_35: - Use Android API 35 on the device/emulator
1 tests PASSED
- ✅ TEST_OSK (PASSED) (notes)

Test Artifacts

Android

ermshiperete · 2025-09-22T07:42:06Z

On my phone, the keyboard shows up correctly if the Keyman app is running. However, then I can't select a text suggestion.
If the Keyman app is not running the keyboard still shows behind the system buttons, but typing + suggestions work.
In the Keyman app, the keyboard is showing correctly and the text suggestions work.

ermshiperete · 2025-09-22T12:57:42Z

Also seeing the wrong behavior in the emulator: Pixel 9, API 35, Android 15.

Reverts part of #14619

ermshiperete · 2025-09-23T12:49:09Z

With the latest commit keyboards now show correctly on my phone, and as you said in the code comment the suggestions banner still doesn't work.

ermshiperete · 2025-09-23T19:48:24Z

Not everything works: in some apps, e.g. messages, the edit field appears behind the keyboard.

screen-20250923-214356.mp4

darcywong00 · 2025-09-24T01:48:39Z

As of ddc9948 the alignments should work on @ermshiperete and my device. (independent of Keyman app running)

Remaining Keyman system keyboard issues on @ermshiperete 's device:

can't click suggestion bar (maybe landscape orientation works?)
some app fields covered by the suggestion bar

ermshiperete · 2025-09-24T06:47:57Z

With 0a91f50 I can confirm that everything works in landscape orientation.
In portrait, clicking the suggestion bar doesn't work and some fields are behind the suggestion bar. This is independent of the Keyman app running.

…/android/some-bottom-inset # Keyman Conventional Commit suggestions: # # - Link to a Sentry issue with git trailer: # Fixes: _MODULE_-_ID_ # - Give credit to co-authors: # Co-authored-by: _Name_ <_email_> # - Use imperative, present tense ('attach' not 'attaches', 'attached' etc) # - Don't include a period at the end of the title # - Always include a blank line before trailers # - More: https://github.com/keymanapp/keyman/wiki/Pull-Request-and-Commit-workflow-notes

darcywong00 · 2025-09-25T03:43:11Z

Huzzah - suggestion bar on the system keyboard works in 8af7803

Turns out I had to adjust the contentTopOffset computation to include the navigation bar inset.

This should be ready to review and test for several API levels

mcdurdin

LGTM. Do we need to document getNavigationBarHeight in the Engine API? And I assume back-port to 18.0 is coming?

darcywong00 · 2025-09-25T07:57:42Z

LGTM. Do we need to document getNavigationBarHeight in the Engine API? And I assume back-port to 18.0 is coming?

Yep, documented in #14830 and will 🍒 pick to 18.0

ermshiperete · 2025-09-25T10:17:54Z

👍 Works correctly on my phone.

dinakaranr · 2025-09-25T11:02:02Z

Test Results

I tested this PR in the "Keyman 19.0.126-alpha-test-14808" build on Android API 31, 34, 35. Here I am sharing my observation.

GROUP_API_31: - Use Android API 31 on the device/emulator

TEST_OSK (Passed):

Install the "Keyman 19.0.126-alpha-test-14808" PR build on the Pixel 7a API 31 platform.
Launch Keyman and dismiss the Get Started menu.
Verified the in-app keyboard functions
a. base keys
b. longpress keys
c. suggestion banner
Force-quit Keyman in the system settings(from background)
Launch Chrome and select a text area to type in (e.g. online editor)
Select a non-Keyman system keyboard
Select the Keyman system keyboard
Verified the Keyman OSK is not covered by the bottom navigation bar
Verified there's no gap between the Keyman OSK and the bottom navigation bar
Verified the Keyman system keyboard functions
a. base keys
b. longpress keys
c. suggestion banner
Verified that keyboard function works above three options.
Launch Keyman
Return to Chrome and select a text area to type in the search box.
Verified the Keyman OSK is not covered by the bottom navigation bar.
Verified there's no gap between the Keyman OSK and the bottom navigation bar.

GROUP_API_34: - Use Android API 34 on the device/emulator

TEST_OSK (Passed):

Install the "Keyman 19.0.126-alpha-test-14808" PR build on the Pixel 7a API 34 platform.
Launch Keyman and dismiss the Get Started menu.
Verified the in-app keyboard functions
a. base keys
b. longpress keys
c. suggestion banner
Force-quit Keyman in the system settings(from background)
Launch Chrome and select a text area to type in (e.g. online editor)
Select a non-Keyman system keyboard
Select the Keyman system keyboard
Verified the Keyman OSK is not covered by the bottom navigation bar
Verified there's no gap between the Keyman OSK and the bottom navigation bar
Verified the Keyman system keyboard functions
a. base keys
b. longpress keys
c. suggestion banner
Verified that keyboard function works above three options.
Launch Keyman
Return to Chrome and select a text area to type in the search box.
Verified the Keyman OSK is not covered by the bottom navigation bar.
Verified there's no gap between the Keyman OSK and the bottom navigation bar.

GROUP_API_35: - Use Android API 35 on the device/emulator

TEST_OSK (Passed):

Install the "Keyman 19.0.126-alpha-test-14808" PR build on the Pixel 7a API 35 platform.
Launch Keyman and dismiss the Get Started menu.
Verified the in-app keyboard functions
a. base keys
b. longpress keys
c. suggestion banner
Force-quit Keyman in the system settings(from background)
Launch Chrome and select a text area to type in (e.g. online editor)
Select a non-Keyman system keyboard
Select the Keyman system keyboard
Verified the Keyman OSK is not covered by the bottom navigation bar
Verified there's no gap between the Keyman OSK and the bottom navigation bar
Verified the Keyman system keyboard functions
a. base keys
b. longpress keys
c. suggestion banner
Verified that keyboard function works above three options.
Launch Keyman
Return to Chrome and select a text area to type in the search box.
Verified the Keyman OSK is not covered by the bottom navigation bar.
Verified there's no gap between the Keyman OSK and the bottom navigation bar.
It works well. There is no keyman keyboard overlapped on the navigation bar. There is no blank space between keyboard and navigation bar.

keyman-server · 2025-09-25T18:01:39Z

Changes in this pull request will be available for download in Keyman version 19.0.127-alpha

darcywong00 added this to the A19S12 milestone Sep 22, 2025

github-project-automation bot moved this to Todo in Keyman Sep 22, 2025

github-project-automation bot added this to Keyman Sep 22, 2025

github-actions bot added android/ android/engine/ fix labels Sep 22, 2025

keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Sep 22, 2025

darcywong00 added 2 commits September 23, 2025 08:26

fix(android): Apply bottom insets to system keyboard

440f6c9

Reverts part of #14619

fix(android): Separate insets for inapp and system keyboard

aa886ce

darcywong00 force-pushed the fix/android/some-bottom-inset branch from dec72a0 to aa886ce Compare September 23, 2025 10:08

github-actions bot added the android/app/ label Sep 23, 2025

fix(android): Fix the alignment

ddc9948

fix(android): Move setting system keyboard insets to KMManager

0a91f50

darcywong00 added 2 commits September 25, 2025 10:04

fix(android): Adjust top insets for the navigation bar inset

8af7803

darcywong00 requested review from ermshiperete and jahorton September 25, 2025 03:52

darcywong00 marked this pull request as ready for review September 25, 2025 03:52

dinakaranr self-assigned this Sep 25, 2025

darcywong00 mentioned this pull request Sep 25, 2025

fix(android): Fix bottom insets for Sample and FirstVoices apps #14828

Merged

mcdurdin approved these changes Sep 25, 2025

View reviewed changes

darcywong00 mentioned this pull request Sep 25, 2025

docs(android): Document getNavigationBarHeight API #14830

Merged

ermshiperete approved these changes Sep 25, 2025

View reviewed changes

keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Sep 25, 2025

dinakaranr removed their assignment Sep 25, 2025

jahorton approved these changes Sep 25, 2025

View reviewed changes

darcywong00 merged commit b04309c into master Sep 25, 2025
7 checks passed

darcywong00 deleted the fix/android/some-bottom-inset branch September 25, 2025 13:52

github-project-automation bot moved this from Todo to Done in Keyman Sep 25, 2025

darcywong00 mentioned this pull request Sep 25, 2025

fix(android): Apply bottom insets to system keyboard for Keyman, KMSample2, and FirstVoices 🏠 #14833

Merged

darcywong00 mentioned this pull request Sep 30, 2025

bug(android): Top of system keyboard covering up text area #14864

Closed

darcywong00 mentioned this pull request Oct 7, 2025

fix(android): Refactor bottom inset calculations for in-app and system keyboard #14873

Merged

Uh oh!

Conversation

darcywong00 commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User Testing

Uh oh!

keymanapp-test-bot bot commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User Test Results

Test Artifacts

Uh oh!

ermshiperete commented Sep 22, 2025

Uh oh!

ermshiperete commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ermshiperete commented Sep 23, 2025

Uh oh!

ermshiperete commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

darcywong00 commented Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ermshiperete commented Sep 24, 2025

Uh oh!

darcywong00 commented Sep 25, 2025

Uh oh!

mcdurdin left a comment

Choose a reason for hiding this comment

Uh oh!

darcywong00 commented Sep 25, 2025

Uh oh!

ermshiperete commented Sep 25, 2025

Uh oh!

dinakaranr commented Sep 25, 2025

Test Results

GROUP_API_31: - Use Android API 31 on the device/emulator

GROUP_API_34: - Use Android API 34 on the device/emulator

GROUP_API_35: - Use Android API 35 on the device/emulator

Uh oh!

Uh oh!

keyman-server commented Sep 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

darcywong00 commented Sep 22, 2025 •

edited

Loading

keymanapp-test-bot bot commented Sep 22, 2025 •

edited

Loading

ermshiperete commented Sep 22, 2025 •

edited

Loading

ermshiperete commented Sep 23, 2025 •

edited

Loading

darcywong00 commented Sep 24, 2025 •

edited

Loading