fix(android): Always display HTML banner when suggestions aren't available #9696

darcywong00 · 2023-10-06T03:09:23Z

Follows #9591 in fixing #9573

With the move to web-based popup key longpresses, Keyman for Android needs to display an ~~image~~ HTML banner for keyboards w/o suggestions. This allows the popup keys to then be displayed in the banner.

Change to KeymanWeb
* On Android device, default to image banner with a black banner "theme".

Change to Keyman Engine for Android

Specify a fallback black/gray banner so Keyboard apps will always have a region for popup key longpresses.
KMManager.setHTMLBanner() allows developers to pass an HTML blob to use for the banner.

Change to Keyman for Android

Use the Keyman theme (with tri-color band) for both in-app and system keyboard
Add BannerController helper to apply banner theming

Change to FV for Android

Use the FV theme (with gold band) for system keyboard

TODO

I'm having issues getting KeymanWeb to display the specified image banner theme on first load. (In-app keyboard banner specified a white banner in MainActivity and system keyboard banner specified a Keyman banner in SystemKeyboard). Thanks to @jahorton for helping me resolve this
Apply Android tablet theme
Apply FV theme

Current limitations
I'm using the Keyman landscape png as generated by https://elmah.io/tools/base64-image-encoder/
There's notificable distortion as the Android app doesn't do computations like the iOS image banner.
Perhaps this can all be moved to KeymanWeb?

This is now resolved using svg within the HTML blob.

Original Screenshots

(edited) These are all obsolete with the svg/html refactor

In-app keyboard

white image banner when suggestions not available

System keyboard

Keyman banner when suggestions not available

Keyman banner in landscape

KMSample2

Test app with Tamil dictionary temporarily disabled to show custom light-blue theme

FV for Android

User Testing

Setup - Install the PR build of the corresponding Android app on an Android device/emulator of SDK 21

TEST_KEYMAN_PHONE Verifies theme shows on in-app and system keyboard (when suggestion banner isn't used)

Install Keyman for Android
With the phone in Portrait orientation from the Keyman app, install a keyboard that doesn't use a dictionary (e.g. sil_ipa). Note, the shift key sometimes registers as a camera control in the emulator, so maybe search for ipa instead of sil_ipa.
When the sil_ipa keyboard is installed, verify the suggestion banner is replaced with a white white banner
Verify you can long-press keys on top row and they appear in the image banner
From Keyman settings, enable Keyman as the default system keyboard.
Rotate the device to landscape orientation
Verify the Keyman banner on the keyboard fills the keyboard width.
Rotate the device back to portrait orientation
Launch a separate app (e.g. Google Chrome)
In Google Chrome, select a text field and switch to Keyman sil_ipa keyboard
Verify the sil_ipa keyboard shows a Keyman image banner
Verify you can long-press keys on the top row and they appear in the image banner.

TEST_FV - Verifies theme on FirstVoices system keyboard (when suggestion banner isn't used)

Install FirstVoices for Android
With the phone in Portrait orientation from the FV app, install:

BC Coast --> Haisla (a keyboard that doesn't use a dictionary)
BC Coast --> SENCOTEN (a keyboard that does use a dictionary)

From the FV app, set FV as the default system keyboard
Launch a separate app (e.g. Google Chrome)
In Google Chrome, select a text field and switch to the FV Haisla keyboard
Verify the FV keyboard shows with a red FirstVoices banner
Verify you can long-press keys on the top row and they appear in the image banner.
Use the globe key to switch to the FV Sencoten keyboard
Verify the FV keyboard shows suggestions

Toggle from suggestion to image banner

keymanapp-test-bot · 2023-10-06T03:09:26Z

User Test Results

Test specification and instructions

✅ TEST_KEYMAN_PHONE (PASSED): Retested with the attached PR build Keyman 17.0.212-alpha-test-9696 in an Android (ver 5.0) emulator (API 21) and here is my observation: 1. Installed sil_ipa keyboard. Verified that the suggestion banner is replaced with a white banner. Also, verified that the long-press keys on to row and they appeared in the image banner. 2. Changed to Landscape orientation and verified that the suggestion banner appeared as expected. 3. Set the Keyman as the system-wide and default keyboard. 4. Opened a browser window. Typed in the Search bar. Able to see the Keyman banner appears in the sil_ipa keyboard. (notes)
✅ TEST_FV (PASSED): Tested with the attached PR build FirstVoices 17.0.212-alpha-test-9696 in an Android (ver 5.0) emulator (API 21) and here is my observation: 1. After setting FirstVoices keyboard as the system keyboard. 2. Opened the browser window. Clicked the Google Search bar. 3. Able to see the FirstVoices banner on the Haisla keyboard. 4. Switch to the Sencoten keyboard. 5. Verified the Suggestion bar appears on the top of the keyboard. (notes)

Test Artifacts

Android

…/android/image-banner

darcywong00 · 2023-11-17T03:23:32Z

@bharanidharanj caught that the banner doesn't refresh when KeymanWeb reloads. I've added a commit to fix Keyman and FV apps.

@keymanapp-test-bot retest TEST_KEYMAN_PHONE

bharanidharanj · 2023-11-17T06:34:37Z

@bharanidharanj caught that the banner doesn't refresh when KeymanWeb reloads. I've added a commit to fix Keyman and FV apps.

@keymanapp-test-bot retest TEST_KEYMAN_PHONE

@darcywong00 Okay, Thanks.

bharanidharanj · 2023-11-17T07:47:59Z

Test Results

TEST_KEYMAN_PHONE (FAILED): Retested with the updated build (Keyman 17.0.212-alpha-test-9696) in an Android 5.0 (API 21) emulator and I can reproduce this issue. (ie., Keyman banner is missing after swapping the keyboard using the globe key in the browser view)
TEST_FV (FAILED): Tested with the attached PR build FirstVoices 17.0.212-alpha-test-9696 in an Android (ver 5.0) emulator (API 21) and here is my observation: 1. After setting FirstVoices keyboard as the system keyboard, I opened the browser window. 2. Set Haisla FirstVoices keyboard as the system keyboard and noticed that the banner is missing on the OSK.

darcywong00 · 2023-11-17T09:13:26Z

@bharanidharanj - I cannot repro the blank banners you saw. Did find a typo and pushed an update.
Did you uninstall the previous apps and delete the previous apk's when you retest?

@keymanapp-test-bot retest

bharanidharanj · 2023-11-17T09:28:07Z

@bharanidharanj - I cannot repro the blank banners you saw. Did find a typo and pushed an update. Did you uninstall the previous apps and delete the previous apk's when you retest?

@keymanapp-test-bot retest

@darcywong00 Yes, Darcy. I have uninstalled the previous apps and deleted the previous apk files before the retest. I am getting this error (black banner) when I opened the keyman keyboard (as a system keyboard) in the browser view. Anyhow, I will retest it. Thanks.

bharanidharanj · 2023-11-17T10:42:10Z

Test Results

TEST_KEYMAN_PHONE (PASSED): Retested with the attached PR build Keyman 17.0.212-alpha-test-9696 in an Android (ver 5.0) emulator (API 21) and here is my observation: 1. Installed sil_ipa keyboard. Verified that the suggestion banner is replaced with a white banner. Also, verified that the long-press keys on to row and they appeared in the image banner. 2. Changed to Landscape orientation and verified that the suggestion banner appeared as expected. 3. Set the Keyman as the system-wide and default keyboard. 4. Opened a browser window. Typed in the Search bar. Able to see the Keyman banner appears in the sil_ipa keyboard.

TEST_FV (PASSED): Tested with the attached PR build FirstVoices 17.0.212-alpha-test-9696 in an Android (ver 5.0) emulator (API 21) and here is my observation: 1. After setting FirstVoices keyboard as the system keyboard. 2. Opened the browser window. Clicked the Google Search bar. 3. Able to see the FirstVoices banner on the Haisla keyboard. 4. Switch to the Sencoten keyboard. 5. Verified the Suggestion bar appears on the top of the keyboard.

..Haisla keyboard

..Sencoten keyboard

keyman-server · 2023-11-17T18:02:01Z

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

darcywong00 added 11 commits October 6, 2023 09:46

change(android): Add image banner

4273140

Toggle from suggestion to image banner

fix(android/engine): Try green banner

9b06591

fix(web): Start with image banner

d3872ee

chore(android/app): Use white banner theme

3a785f5

chore(web): Revert initial banner

b46d50f

refactor(android/engine): Move constants to KMManager

3df2668

refactor(android): Change set/getBanner

131180c

fix(android): Set image path

db728df

chore(web): Default to image banner on Android

b91d651

fix(web): Handle banner initialization

7d3de5a

fix(android/engine): Use white and Keyman theme banners

018abd4

keymanapp-test-bot bot added the user-test-missing User tests have not yet been defined for the PR label Oct 6, 2023

keymanapp-test-bot bot added this to the A17S23 milestone Oct 6, 2023

github-actions bot added web/ android/ android/engine/ android/app/ fix labels Oct 6, 2023

darcywong00 added 3 commits October 6, 2023 14:15

fix(web): Update image path when setting Options

a5aef7a

fix(android/engine): Remove refresh that wasn't working

510de72

chore(web): Add Android tablet theme

d366f33

mcdurdin modified the milestones: A17S23, A17S24 Oct 15, 2023

darcywong00 added 5 commits October 16, 2023 07:40

chore(android): Merge remote-tracking branch 'origin/master' into fix…

b45c61e

…/android/image-banner

chore(android): Merge remote-tracking branch 'origin/master' into fix…

8a48fd2

…/android/image-banner

chore(android/engine): Move banner names

bb5a9f8

feat(oem/fv/android): Add banner theme

a6b7b95

feat(android/samples): Add sample code for theme on KMSample2

926a2a2

github-actions bot added the oem/ label Oct 26, 2023

github-actions bot added android/samples/ ios/ ios/engine/ and removed ios/engine/ android/samples/ labels Nov 17, 2023

keymanapp-test-bot bot removed the user-test-failed label Nov 17, 2023

keymanapp-test-bot bot added user-test-failed and removed user-test-required User tests have not been completed labels Nov 17, 2023

fix(android/engine): Fix typo

4ebc1e2

github-actions bot added android/samples/ ios/ ios/engine/ and removed ios/ ios/engine/ android/samples/ labels Nov 17, 2023

keymanapp-test-bot bot added user-test-required User tests have not been completed and removed user-test-failed labels Nov 17, 2023

keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Nov 17, 2023

darcywong00 merged commit cb1b995 into master Nov 17, 2023
2 checks passed

darcywong00 deleted the fix/android/image-banner branch November 17, 2023 10:54

darcywong00 linked an issue Nov 17, 2023 that may be closed by this pull request

change(android): Web-based popup key longpressses #9573

Closed

darcywong00 mentioned this pull request Nov 17, 2023

change(android): Web-based popup key longpressses #9573

Closed

darcywong00 mentioned this pull request Nov 21, 2023

chore: Add docs for Android HTML banner keymanapp/help.keyman.com#882

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(android): Always display HTML banner when suggestions aren't available #9696

fix(android): Always display HTML banner when suggestions aren't available #9696

darcywong00 commented Oct 6, 2023 •

edited

Loading

keymanapp-test-bot bot commented Oct 6, 2023 •

edited

Loading

darcywong00 commented Nov 17, 2023

bharanidharanj commented Nov 17, 2023

bharanidharanj commented Nov 17, 2023

darcywong00 commented Nov 17, 2023

bharanidharanj commented Nov 17, 2023

bharanidharanj commented Nov 17, 2023

keyman-server commented Nov 17, 2023

fix(android): Always display HTML banner when suggestions aren't available #9696

fix(android): Always display HTML banner when suggestions aren't available #9696

Conversation

darcywong00 commented Oct 6, 2023 • edited Loading

Original Screenshots

In-app keyboard

System keyboard

KMSample2

FV for Android

User Testing

keymanapp-test-bot bot commented Oct 6, 2023 • edited Loading

User Test Results

Test Artifacts

darcywong00 commented Nov 17, 2023

bharanidharanj commented Nov 17, 2023

bharanidharanj commented Nov 17, 2023

Test Results

darcywong00 commented Nov 17, 2023

bharanidharanj commented Nov 17, 2023

bharanidharanj commented Nov 17, 2023

Test Results

keyman-server commented Nov 17, 2023

darcywong00 commented Oct 6, 2023 •

edited

Loading

keymanapp-test-bot bot commented Oct 6, 2023 •

edited

Loading