Workaround for dysfunctional UIKeyboardLayoutGuide on iOS 15.

igor-signal · max-signal · commit 1384c0a260fc · 2025-10-02T13:18:01.000-05:00
• bring back keyboard frame tracking to OWSViewController if running on iOS 15.
• add our own layout guide to OWSViewController that is updated based on keyboard frame notifications on iOS 15; on newer iOS versions it's a proxy to view.keyboardLayoutGuide.
• use OWSViewController.keyboardLayoutGuide where needed.
• in media composer screen (not OWSVIewController subclass) we already track keyboard frame - use that to position bottom toolbar on iOS 15.

I have also discovered that profile avatar editing screen was somewhat broken on older (15, 16) iOS versions. Fixed that here.
diff --git a/Signal/Registration/UserInterface/RegistrationPhoneNumberViewController.swift b/Signal/Registration/UserInterface/RegistrationPhoneNumberViewController.swift
@@ -247,7 +247,7 @@ class RegistrationPhoneNumberViewController: OWSViewController {
         cancelButton.translatesAutoresizingMaskIntoConstraints = false
         NSLayoutConstraint.activate([
             cancelButton.centerXAnchor.constraint(equalTo: view.centerXAnchor),
-            cancelButton.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor, constant: -24),
+            cancelButton.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor, constant: -24),
         ])
 
         render()
diff --git a/Signal/Registration/UserInterface/RegistrationPinViewController.swift b/Signal/Registration/UserInterface/RegistrationPinViewController.swift
@@ -365,7 +365,7 @@ class RegistrationPinViewController: OWSViewController {
             scrollView.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
             scrollView.leadingAnchor.constraint(equalTo: view.layoutMarginsGuide.leadingAnchor),
             scrollView.trailingAnchor.constraint(equalTo: view.layoutMarginsGuide.trailingAnchor),
-            scrollView.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            scrollView.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         scrollView.addSubview(stackView)
diff --git a/Signal/Registration/UserInterface/RegistrationProfileViewController.swift b/Signal/Registration/UserInterface/RegistrationProfileViewController.swift
@@ -263,7 +263,7 @@ class RegistrationProfileViewController: OWSViewController {
             scrollView.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
             scrollView.leadingAnchor.constraint(equalTo: view.layoutMarginsGuide.leadingAnchor),
             scrollView.trailingAnchor.constraint(equalTo: view.layoutMarginsGuide.trailingAnchor),
-            scrollView.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            scrollView.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         let stackView = UIStackView()
diff --git a/Signal/Registration/UserInterface/RegistrationVerificationViewController.swift b/Signal/Registration/UserInterface/RegistrationVerificationViewController.swift
@@ -259,7 +259,7 @@ class RegistrationVerificationViewController: OWSViewController {
             scrollView.topAnchor.constraint(equalTo: view.layoutMarginsGuide.topAnchor),
             scrollView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
             scrollView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
-            scrollView.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            scrollView.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         let stackView = UIStackView()
diff --git a/Signal/Usernames/Selection/UsernameSelectionViewController.swift b/Signal/Usernames/Selection/UsernameSelectionViewController.swift
@@ -317,7 +317,7 @@ class UsernameSelectionViewController: OWSViewController, OWSNavigationChildCont
             wrapperScrollView.topAnchor.constraint(equalTo: view.layoutMarginsGuide.topAnchor),
             wrapperScrollView.leadingAnchor.constraint(equalTo: view.layoutMarginsGuide.leadingAnchor),
             wrapperScrollView.trailingAnchor.constraint(equalTo: view.layoutMarginsGuide.trailingAnchor),
-            wrapperScrollView.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            wrapperScrollView.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         let contentLayoutGuide = wrapperScrollView.contentLayoutGuide
diff --git a/Signal/src/ViewControllers/AppSettings/Payments/PaymentsRestoreWalletWordViewController.swift b/Signal/src/ViewControllers/AppSettings/Payments/PaymentsRestoreWalletWordViewController.swift
@@ -65,7 +65,7 @@ public class PaymentsRestoreWalletWordViewController: OWSViewController {
             rootView.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
             rootView.leadingAnchor.constraint(equalTo: view.layoutMarginsGuide.leadingAnchor),
             rootView.trailingAnchor.constraint(equalTo: view.layoutMarginsGuide.trailingAnchor),
-            rootView.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            rootView.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         updateContents()
diff --git a/Signal/src/ViewControllers/Avatars/AvatarEditViewController.swift b/Signal/src/ViewControllers/Avatars/AvatarEditViewController.swift
@@ -6,7 +6,7 @@
 import SignalServiceKit
 import SignalUI
 
-class AvatarEditViewController: OWSViewController {
+class AvatarEditViewController: OWSViewController, OWSNavigationChildController {
     private let originalModel: AvatarModel
     private var model: AvatarModel {
         didSet {
@@ -32,9 +32,15 @@ class AvatarEditViewController: OWSViewController {
         return UIDevice.current.isIPad ? .all : .portrait
     }
 
+    var preferredNavigationBarStyle: OWSNavigationBarStyle { .solid }
+
+    var navbarBackgroundColorOverride: UIColor? { UIColor.Signal.groupedBackground }
+
     override func viewDidLoad() {
         super.viewDidLoad()
 
+        view.backgroundColor = UIColor.Signal.groupedBackground
+
         updateNavigation()
         updateHeaderViewState()
         updateFooterViewState()
@@ -46,7 +52,7 @@ class AvatarEditViewController: OWSViewController {
             scrollView.frameLayoutGuide.topAnchor.constraint(equalTo: view.layoutMarginsGuide.topAnchor),
             scrollView.frameLayoutGuide.leadingAnchor.constraint(equalTo: view.readableContentGuide.leadingAnchor),
             scrollView.frameLayoutGuide.trailingAnchor.constraint(equalTo: view.readableContentGuide.trailingAnchor),
-            scrollView.frameLayoutGuide.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor, constant: -8),
+            scrollView.frameLayoutGuide.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor, constant: -8),
         ])
 
         scrollView.addSubview(topHeader)
diff --git a/Signal/src/ViewControllers/Donations/DonateViewController.swift b/Signal/src/ViewControllers/Donations/DonateViewController.swift
@@ -105,7 +105,7 @@ class DonateViewController: OWSViewController, OWSNavigationChildController {
             scrollView.topAnchor.constraint(equalTo: view.topAnchor),
             scrollView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
             scrollView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
-            scrollView.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            scrollView.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         NotificationCenter.default.addObserver(
diff --git a/Signal/src/ViewControllers/GifPicker/GifPickerViewController.swift b/Signal/src/ViewControllers/GifPicker/GifPickerViewController.swift
@@ -295,7 +295,7 @@ class GifPickerViewController: OWSViewController, UISearchBarDelegate, UICollect
             bottomBanner.topAnchor.constraint(equalTo: bottomBannerContainer.topAnchor),
             bottomBanner.leadingAnchor.constraint(equalTo: bottomBannerContainer.leadingAnchor),
             bottomBanner.trailingAnchor.constraint(equalTo: bottomBannerContainer.trailingAnchor),
-            bottomBanner.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            bottomBanner.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         // The Giphy API requires us to "show their trademark prominently" in our GIF experience.
diff --git a/Signal/src/ViewControllers/HomeView/Stories/Replies & Views Sheets/Group Reply Sheet/StoryGroupReplyViewController.swift b/Signal/src/ViewControllers/HomeView/Stories/Replies & Views Sheets/Group Reply Sheet/StoryGroupReplyViewController.swift
@@ -89,7 +89,7 @@ class StoryGroupReplyViewController: OWSViewController, StoryReplySheet {
             bottomBar.topAnchor.constraint(equalTo: tableView.bottomAnchor),
             bottomBar.leadingAnchor.constraint(equalTo: view.leadingAnchor),
             bottomBar.trailingAnchor.constraint(equalTo: view.trailingAnchor),
-            bottomBar.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            bottomBar.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
         // Its a bit silly but this is the easiest way to capture touches
         // and not let them pass up to any parent scrollviews. pans inside the
diff --git a/Signal/src/ViewControllers/HomeView/Stories/Replies & Views Sheets/StoryDirectReplySheet.swift b/Signal/src/ViewControllers/HomeView/Stories/Replies & Views Sheets/StoryDirectReplySheet.swift
@@ -61,7 +61,7 @@ public class StoryDirectReplySheet: OWSViewController, StoryReplySheet {
             inputToolbar.leadingAnchor.constraint(equalTo: view.leadingAnchor),
             inputToolbar.trailingAnchor.constraint(equalTo: view.trailingAnchor),
             inputToolbarBottomConstraint,
-            inputToolbar.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            inputToolbar.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
         self.inputToolbarBottomConstraint = inputToolbarBottomConstraint
     }
diff --git a/Signal/src/ViewControllers/OWSPinConfirmationViewController.swift b/Signal/src/ViewControllers/OWSPinConfirmationViewController.swift
@@ -91,7 +91,7 @@ public class PinConfirmationViewController: OWSViewController {
         NSLayoutConstraint.activate([
             containerView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
             containerView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
-            containerView.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            containerView.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         // We want the background to extend to the bottom of the screen
diff --git a/Signal/src/ViewControllers/OWSPinReminderViewController.swift b/Signal/src/ViewControllers/OWSPinReminderViewController.swift
@@ -88,7 +88,7 @@ public class PinReminderViewController: OWSViewController {
             containerView.topAnchor.constraint(greaterThanOrEqualTo: view.safeAreaLayoutGuide.topAnchor),
             containerView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
             containerView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
-            containerView.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            containerView.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         // We want the background to extend to the bottom of the screen
diff --git a/Signal/src/ViewControllers/OWSPinSetupViewController.swift b/Signal/src/ViewControllers/OWSPinSetupViewController.swift
@@ -324,7 +324,7 @@ public class PinSetupViewController: OWSViewController, OWSNavigationChildContro
             stackView.topAnchor.constraint(equalTo: view.layoutMarginsGuide.topAnchor),
             stackView.leadingAnchor.constraint(equalTo: view.layoutMarginsGuide.leadingAnchor),
             stackView.trailingAnchor.constraint(equalTo: view.layoutMarginsGuide.trailingAnchor),
-            stackView.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            stackView.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         [pinTextField, validationWarningLabel, recommendationLabel].forEach {
diff --git a/Signal/src/ViewControllers/Payments/SendPaymentMemoViewController.swift b/Signal/src/ViewControllers/Payments/SendPaymentMemoViewController.swift
@@ -45,7 +45,7 @@ public class SendPaymentMemoViewController: OWSViewController {
             rootStack.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
             rootStack.leadingAnchor.constraint(equalTo: view.layoutMarginsGuide.leadingAnchor),
             rootStack.trailingAnchor.constraint(equalTo: view.layoutMarginsGuide.trailingAnchor),
-            rootStack.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor, constant: -16),
+            rootStack.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor, constant: -16),
         ])
 
         updateContents()
diff --git a/Signal/src/ViewControllers/Payments/SendPaymentViewController.swift b/Signal/src/ViewControllers/Payments/SendPaymentViewController.swift
@@ -710,7 +710,7 @@ public class SendPaymentViewController: OWSViewController {
             rootStack.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
             rootStack.leadingAnchor.constraint(equalTo: view.layoutMarginsGuide.leadingAnchor, constant: 20),
             rootStack.trailingAnchor.constraint(equalTo: view.layoutMarginsGuide.trailingAnchor, constant: -20),
-            rootStack.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor, constant: -24),
+            rootStack.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor, constant: -24),
         ])
 
         bigAmountLabel.font = UIFont.regularFont(ofSize: 60)
diff --git a/SignalUI/AttachmentApproval/AttachmentApprovalViewController.swift b/SignalUI/AttachmentApproval/AttachmentApprovalViewController.swift
@@ -118,7 +118,12 @@ public class AttachmentApprovalViewController: UIPageViewController, UIPageViewC
     private var observerToken: NSObjectProtocol?
 
     private var observingKeyboardNotifications = false
-    private var keyboardHeight: CGFloat = 0
+    private var keyboardHeight: CGFloat = 0 {
+        didSet {
+            guard let iOS15BottomToolviewVerticalPositionConstraint else { return }
+            iOS15BottomToolviewVerticalPositionConstraint.constant = -max(view.safeAreaInsets.bottom, keyboardHeight)
+        }
+    }
 
     public init(options: AttachmentApprovalViewControllerOptions, attachmentApprovalItems: [AttachmentApprovalItem]) {
         assert(attachmentApprovalItems.count > 0)
@@ -197,6 +202,9 @@ public class AttachmentApprovalViewController: UIPageViewController, UIPageViewC
 
     private let bottomToolView = AttachmentApprovalToolbar()
 
+    // Manually adjust position of the bottom toolbar on iOS 15 because `keyboardLayoutGuide` is buggy.
+    private var iOS15BottomToolviewVerticalPositionConstraint: NSLayoutConstraint?
+
     lazy var contentDimmerView: UIView = {
         let dimmerView = UIView()
         dimmerView.backgroundColor = .ows_blackAlpha40
@@ -267,8 +275,16 @@ public class AttachmentApprovalViewController: UIPageViewController, UIPageViewC
         NSLayoutConstraint.activate([
             bottomToolView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
             bottomToolView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
-            bottomToolView.contentLayoutGuide.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
         ])
+        if #unavailable(iOS 16) {
+            let constraint = bottomToolView.contentLayoutGuide.bottomAnchor.constraint(equalTo: view.bottomAnchor, constant: -view.safeAreaInsets.bottom)
+            constraint.isActive = true
+            iOS15BottomToolviewVerticalPositionConstraint = constraint
+        } else {
+            NSLayoutConstraint.activate([
+                bottomToolView.contentLayoutGuide.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor)
+            ])
+        }
 
         OWSTableViewController2.removeBackButtonText(viewController: self)
     }
@@ -304,6 +320,9 @@ public class AttachmentApprovalViewController: UIPageViewController, UIPageViewC
     public override func viewSafeAreaInsetsDidChange() {
         super.viewSafeAreaInsetsDidChange()
 
+        if let iOS15BottomToolviewVerticalPositionConstraint {
+            iOS15BottomToolviewVerticalPositionConstraint.constant = -max(view.safeAreaInsets.bottom, keyboardHeight)
+        }
         if let currentPageViewController {
             updateContentLayoutMargins(for: currentPageViewController)
         }
diff --git a/SignalUI/ImageEditor/ImageEditorViewController+Text.swift b/SignalUI/ImageEditor/ImageEditorViewController+Text.swift
@@ -78,7 +78,7 @@ extension ImageEditorViewController {
             textViewContainer.topAnchor.constraint(equalTo: view.topAnchor),
             textViewContainer.leadingAnchor.constraint(equalTo: view.leadingAnchor),
             textViewContainer.trailingAnchor.constraint(equalTo: view.trailingAnchor),
-            textViewContainer.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            textViewContainer.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         textViewContainer.addGestureRecognizer(ImageEditorPinchGestureRecognizer(target: self, action: #selector(handleTextPinchGesture(_:))))
diff --git a/SignalUI/RecipientPickers/BaseMemberViewController.swift b/SignalUI/RecipientPickers/BaseMemberViewController.swift
@@ -97,7 +97,7 @@ open class BaseMemberViewController: RecipientPickerContainerViewController {
             recipientPicker.view.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
             recipientPicker.view.leadingAnchor.constraint(equalTo: view.safeAreaLayoutGuide.leadingAnchor),
             recipientPicker.view.trailingAnchor.constraint(equalTo: view.safeAreaLayoutGuide.trailingAnchor),
-            recipientPicker.view.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor),
+            recipientPicker.view.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor),
         ])
 
         updateMemberCount()
diff --git a/SignalUI/ViewControllers/OWSTableViewController2.swift b/SignalUI/ViewControllers/OWSTableViewController2.swift
@@ -210,12 +210,12 @@ open class OWSTableViewController2: OWSViewController {
         let bottomFooterConstraint: NSLayoutConstraint
         if !shouldHideBottomFooter, let bottomFooter {
             if shouldAvoidKeyboard {
-                bottomFooterConstraint = bottomFooter.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor)
+                bottomFooterConstraint = bottomFooter.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor)
             } else {
                 bottomFooterConstraint = bottomFooter.bottomAnchor.constraint(equalTo: view.bottomAnchor)
             }
         } else if shouldAvoidKeyboard {
-            bottomFooterConstraint = tableView.bottomAnchor.constraint(equalTo: view.keyboardLayoutGuide.topAnchor)
+            bottomFooterConstraint = tableView.bottomAnchor.constraint(equalTo: keyboardLayoutGuide.topAnchor)
         } else {
             bottomFooterConstraint = tableView.bottomAnchor.constraint(equalTo: view.bottomAnchor)
         }
diff --git a/SignalUI/ViewControllers/OWSViewController.swift b/SignalUI/ViewControllers/OWSViewController.swift
diff --git a/SignalUI/ViewControllers/TextApprovalViewController.swift b/SignalUI/ViewControllers/TextApprovalViewController.swift
