feat(ios): configurable keyboard height #12571

sgschantz · 2024-10-23T12:26:01Z

Allows the height of the Keyman keyboard to be adjusted by the user from within the Keyman Settings.

Fixes #5897

User Testing

TEST_PORTRAIT_KEYBOARD_HEIGHT_ADJUSTMENT:

Install and run the Keyman build associated with this PR
Go to Keyman Settings with the Keyman app
Holding the device in portrait orientation, tap Adjust Keyboard Height
Drag the resizer arrow to adjust the height of the keyboard
Tap the Back button
Tap the Done button
Confirm that the keyboard has been resized within the Keyman app

TEST_LANDSCAPE_KEYBOARD_HEIGHT_ADJUSTMENT:

Install and run the Keyman build associated with this PR
Go to Keyman Settings with the Keyman app
Holding the device in landscape orientation, tap Adjust Keyboard Height
Drag the resizer arrow to adjust the height of the keyboard
Tap the Back button
Tap the Done button
Confirm that the keyboard has been resized within the Keyman app

TEST_SYSTEM_KEYBOARD_HEIGHT_ADJUSTMENT:

Set the keyboard height to a size noticeably different than the default size
Go to an iOS application with text input
Switch to the Keyman system keyboard and confirm that the keyboard height is the same as it was in Keyman

TEST_ADJUST_KEYBOARD_ROTATION:

Go to Keyman Settings within the Keyman app
Tap Adjust Keyboard Height
Rotate the device between portrait and landscape
Confirm that the animation is smooth and the keyboard size changes correctly after rotating

TEST_ADJUST_KEYBOARD_DARK_MODE:

Go to Keyman Settings within the Keyman app
Tap Adjust Keyboard Height
Go to iOS Settings > Display & Brightness
Change Appearance from Light to Dark or vice-versa
Confirm that the blank keyboard displayed on the Adjust Keyboard screen reflect the appearance change

TEST_RESET_TO_DEFAULT:

Go to Keyman Settings within the Keyman app
Tap Adjust Keyboard Height
Resize the keyboard to a height noticeably different from the default
Tap the 'Rest to Default Keyboard Height' button
Confirm that they keyboard size springs back to its original default size

keymanapp-test-bot · 2024-10-23T12:26:12Z

User Test Results

Test specification and instructions

✅ TEST_PORTRAIT_KEYBOARD_HEIGHT_ADJUSTMENT (PASSED) (notes)
✅ TEST_LANDSCAPE_KEYBOARD_HEIGHT_ADJUSTMENT (PASSED) (notes)
✅ TEST_SYSTEM_KEYBOARD_HEIGHT_ADJUSTMENT (PASSED) (notes)
✅ TEST_ADJUST_KEYBOARD_ROTATION (PASSED) (notes)
✅ TEST_ADJUST_KEYBOARD_DARK_MODE (PASSED) (notes)
✅ TEST_RESET_TO_DEFAULT (PASSED) (notes)

Test Artifacts

iOS
- Keyman for iOS (simulator image)
- FirstVoices Keyboards for iOS (simulator image)
- TestFlight internal PR build version - 18.0.130 (0.12571.12434)

need to handle persistance to UserDefaults

viewWillTransition size argument does not reflect device bounds

updates constraints on CustomInputView only so that changes are isolated to the in-app keyboard and have no effect on the system keyboard

also avoid call to userdefaults unless key exists

first check UserDefaults for saved values if no saved values, determine default keyboard heights write default keyboard heights to UserDefaults

Fixes: #5897

mcdurdin

LGTM, just nits. Good work

mcdurdin · 2024-12-09T06:41:07Z

ios/engine/KMEI/KeymanEngine/Classes/KeyboardHeightViewController.swift

+  private func determineDefaultKeyboardHeights() {
+    // if no KeyboardScaleMap found for device, then default to 216.0
+    let portraitKeyboardScale = KeyboardScaleMap.getDeviceDefaultKeyboardScale(forPortrait: true)
+    self.defaultPortraitHeight = Double(portraitKeyboardScale?.keyboardHeight ?? 216.0)


216.0 appears in a few places. Is it worth making it a constant somewhere?

mcdurdin · 2024-12-09T06:42:11Z

ios/engine/KMEI/KeymanEngine/Classes/KeyboardHeightViewController.swift

+    if (self.isPortrait) {
+      if (Storage.active.userDefaults.object(forKey: Key.portraitKeyboardHeight) != nil) {
+        self.keyboardHeight = Storage.active.userDefaults.portraitKeyboardHeight
+        let message = "applyKeyboardHeight, from UserDefaults loaded portrait value \(self.keyboardHeight)"
+        os_log("%{public}s", log:KeymanEngineLogger.ui, type: .debug, message)
+      } else {
+        self.keyboardHeight = self.defaultPortraitHeight
+        let message = "applyKeyboardHeight, portraitHeight not found in UserDefaults, using default value \(self.keyboardHeight)"
+        os_log("%{public}s", log:KeymanEngineLogger.ui, type: .error, message)
+      }
+    } else {
+      if (Storage.active.userDefaults.object(forKey: Key.portraitKeyboardHeight) != nil) {
+        self.keyboardHeight = Storage.active.userDefaults.landscapeKeyboardHeight
+        let message = "applyKeyboardHeight, from UserDefaults loaded landscape value \(self.keyboardHeight)"
+        os_log("%{public}s", log:KeymanEngineLogger.ui, type: .debug, message)
+      } else {
+        self.keyboardHeight = self.defaultLandscapeHeight
+        let message = "applyKeyboardHeight, landscapeHeight not found in UserDefaults, using default value \(self.keyboardHeight)"
+        os_log("%{public}s", log:KeymanEngineLogger.ui, type: .error, message)
+      }
+    }


There's a fair bit of repetition between landscape and portrait orientation code. Could we merge the values into an array (0=portait, 1=landscape) or something like that? What do you think? Or an {x,y}?

dinakaranr · 2024-12-09T14:52:10Z

Test Results

I tested this issue with the attached "Keyman 18.0.130-alpha-test-12571" build(test flight) on the iOS 17.4, iPhone 13 physical device.

TEST_PORTRAIT_KEYBOARD_HEIGHT_ADJUSTMENT (Passed):

I installed the Keyman 18.0.130-alpha-test-12571 version.
Open the Keyman app. Go to the keyman settings.
iPhone device holds in portrait view. Tap on the "Adjust Keyboard Height" option.
Drag the resizer arrow to adjust the height of the keyboard(Small to Big Height).
Tap the Back button.
Tap the Done button.
In Keyman editor: Verified that the keyboard resized within the Keyman app.

TEST_LANDSCAPE_KEYBOARD_HEIGHT_ADJUSTMENT (Passed):

I installed the Keyman 18.0.130-alpha-test-12571 version.
Open the Keyman app. Go to the keyman settings.
iPhone device holds in landscape view. Tap on the "Adjust Keyboard Height" option.
Drag the resizer arrow to adjust the height of the keyboard(Big Height to Small).
Tap the Back button
Tap the Done button
In Keyman editor: Verified that the keyboard resized within the Keyman app.

TEST_SYSTEM_KEYBOARD_HEIGHT_ADJUSTMENT (Passed):

I installed the Keyman 18.0.130-alpha-test-12571 version.
Open the Keyman app. Go to the keyman settings.
iPhone device holds in portrait view. Tap on the "Adjust Keyboard Height" option.
Drag the resizer arrow to increase the small to Big height of the keyboard.
Tap the Back button
Tap the Done button
Set the keyman keyboard as a system keyboard by clicking keyman/Settings/System Keyboard Settings/Keyboards/Allow full access & Keyman
Open the Pages app. Open a blank page.
Click on the blank page.
In Keyman editor: Verified that the keyboard resized with bigger.

TEST_ADJUST_KEYBOARD_ROTATION (Passed):

I installed the Keyman 18.0.130-alpha-test-12571 version.
Open the Keyman app. Go to the keyman settings.
iPhone device holds in portrait view. Tap on the "Adjust Keyboard Height" option.
Rotate the device from portrait to landscape
Verified that the keyboard animation appeared as small size in the landscape view.
Rotate the device from landscape to portrait.
Verified that the keyboard height appeared as a bigger size in the portrait view.
Verified that the keyboard UI appeared correctly when rotating the view in the phone.

TEST_ADJUST_KEYBOARD_DARK_MODE (Passed):

I installed the Keyman 18.0.130-alpha-test-12571 version.
Open the Keyman app. Go to the keyman settings.
iPhone device holds in portrait view. Tap on the "Adjust Keyboard Height" option.
Change the iPhone theme from light to dark mode.
Verified that the keyboard animation appeared in the dark view.
Verified that the white background appeared with blue & black text.
Verified that the blue text is clickable.

TEST_RESET_TO_DEFAULT (Passed):

I installed the Keyman 18.0.130-alpha-test-12571 version.
Open the Keyman app. Go to the keyman settings.
iPhone device holds in portrait view. Tap on the "Adjust Keyboard Height" option.
Drag the resizer arrow to adjust the height of the keyboard(Small to Big Height).
Tap the Back button
Tap the Done button
In Keyman editor: Verified that the keyboard resized within the Keyman app.
Go to the keyman settings. Tap on the "Adjust Keyboard Height" option.
Click on the 'Rest to Default Keyboard Height' button.
Verified that the keyboard is reset to the default size on the keyboard animation.
Tap the Back button
Tap the Done button
In Keyman editor: Verified that the keyboard appeared as the default size in the Keyman app.

add resizeKeyboard logging

246efb4

sgschantz added ios/ feat labels Oct 23, 2024

sgschantz added this to the A18S14 milestone Oct 23, 2024

sgschantz self-assigned this Oct 23, 2024

github-actions bot added the ios/engine/ label Oct 23, 2024

sgschantz added 2 commits October 23, 2024 21:37

correct resizeKeyboard logging

751c853

fix(ios): add Adjust Keyboard Height control to Keyman Settings

0fbf123

Base automatically changed from fix/ios/xcode-16-build to master October 24, 2024 09:08

sgschantz added 5 commits October 25, 2024 14:41

feat(ios): add KeyboardHeightViewController

7b69bed

fix(ios): add subviews for keyboard height adjustment

8695112

fix(ios): add debug logs

048b317

fix(ios): more image layout debugging and experimenting

6decb5d

fix(ios): fix keyboard height layout for portrait

9ff6d70

darcywong00 modified the milestones: A18S14, A18S15 Nov 9, 2024

sgschantz added 7 commits November 14, 2024 22:18

fix(ios): fully functional UI for keyboard height change

9035414

need to handle persistance to UserDefaults

fix(ios): save keyboard height in UserDefaults

b620e17

fix(ios): check for existence of UserDefault setting before read

a8949ef

fix(ios): write new height values to UserDefaults

8caf106

fix(ios): return persisted height from constraintTargetHeight

fe6c818

fix(ios): try alternate image loading method

e989c57

fix(ios): use engine bundle to find image

b9aae00

darcywong00 modified the milestones: A18S15, A18S16 Nov 24, 2024

sgschantz added 4 commits November 26, 2024 10:08

fix(ios): added new blank keyboard assets to keyman engine

607c5cc

fix(ios): use engine bundle -- not Keyman.bundle in engine

fbfb7f3

fix(ios): add strings to bundle for localization

625eed5

fix(ios): fix rotation and resize animations

c3c8e0b

fix(ios): attempt to reload in-app keyboard on keyboard height change

221ba7b

sgschantz force-pushed the fix/ios/5897-adjustable-keyboard-height branch from 506da20 to 221ba7b Compare December 2, 2024 05:30

sgschantz added 6 commits December 2, 2024 13:56

fix(ios): check view changes during device rotation

3e54255

fix(ios): use UIScreen.main.bounds to determine orientation

c47fab0

viewWillTransition size argument does not reflect device bounds

fix(ios): update constraints upon keyboard height change

7c0657a

updates constraints on CustomInputView only so that changes are isolated to the in-app keyboard and have no effect on the system keyboard

fix(ios): allow asynchronous layout update

2d3cde7

fix(ios): add logging, present keyboard height view modally

f2ff959

fix(ios): add more logging to determine first call for keyboard size

b4fb78a

also avoid call to userdefaults unless key exists

darcywong00 modified the milestones: A18S16, A18S17 Dec 7, 2024

sgschantz added 4 commits December 7, 2024 15:30

fix(ios): eliminate circular logging reference in initKeyboardSize()

51d568a

fix(ios): reworked initialization of keyboardSize

026edfe

first check UserDefaults for saved values if no saved values, determine default keyboard heights write default keyboard heights to UserDefaults

fix(ios): clean up and reduce log statements

c9d4c5c

Fixes: #5897

fix(ios): writeKeyboardHeightIfDoesNotExist logic error

b1d23b2

keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Dec 9, 2024

sgschantz marked this pull request as ready for review December 9, 2024 06:31

sgschantz requested a review from jahorton as a code owner December 9, 2024 06:31

sgschantz requested a review from mcdurdin December 9, 2024 06:32

mcdurdin approved these changes Dec 9, 2024

View reviewed changes

keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Dec 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ios): configurable keyboard height #12571

feat(ios): configurable keyboard height #12571

sgschantz commented Oct 23, 2024 •

edited

Loading

keymanapp-test-bot bot commented Oct 23, 2024 •

edited

Loading

mcdurdin left a comment

mcdurdin Dec 9, 2024

mcdurdin Dec 9, 2024

dinakaranr commented Dec 9, 2024

feat(ios): configurable keyboard height #12571

Are you sure you want to change the base?

feat(ios): configurable keyboard height #12571

Conversation

sgschantz commented Oct 23, 2024 • edited Loading

User Testing

keymanapp-test-bot bot commented Oct 23, 2024 • edited Loading

User Test Results

Test Artifacts

mcdurdin left a comment

Choose a reason for hiding this comment

mcdurdin Dec 9, 2024

Choose a reason for hiding this comment

mcdurdin Dec 9, 2024

Choose a reason for hiding this comment

dinakaranr commented Dec 9, 2024

Test Results

sgschantz commented Oct 23, 2024 •

edited

Loading

keymanapp-test-bot bot commented Oct 23, 2024 •

edited

Loading