Replace Safe Area With Top Padding, Smoother Animations

Author: thecoolwinter

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -17,7 +17,7 @@ let package = Package(
         // A fast, efficient, text view for code.
         .package(
             url: "https://github.com/CodeEditApp/CodeEditTextView.git",
-            from: "0.7.9"
+            from: "0.8.1"
         ),
         // tree-sitter languages
         .package(

Package.swift

@@ -29,11 +29,14 @@ extension TextViewController {
             for: .horizontal
         )
 
-        let searchController = FindViewController(target: self, childView: scrollView)
-        addChild(searchController)
-        self.view.addSubview(searchController.view)
-        searchController.view.viewDidMoveToSuperview()
-        self.searchController = searchController
+        let findViewController = FindViewController(target: self, childView: scrollView)
+        addChild(findViewController)
+        self.findViewController = findViewController
+        self.view.addSubview(findViewController.view)
+        findViewController.view.viewDidMoveToSuperview()
+        self.findViewController = findViewController
+
+        findViewController.topPadding = contentInsets?.top ?? view.safeAreaInsets.top
 
         if let _undoManager {
             textView.setUndoManager(_undoManager)
@@ -46,10 +49,10 @@ extension TextViewController {
         setUpTextFormation()
 
         NSLayoutConstraint.activate([
-            searchController.view.leadingAnchor.constraint(equalTo: view.leadingAnchor),
-            searchController.view.trailingAnchor.constraint(equalTo: view.trailingAnchor),
-            searchController.view.topAnchor.constraint(equalTo: view.topAnchor),
-            searchController.view.bottomAnchor.constraint(equalTo: view.bottomAnchor)
+            findViewController.view.leadingAnchor.constraint(equalTo: view.leadingAnchor),
+            findViewController.view.trailingAnchor.constraint(equalTo: view.trailingAnchor),
+            findViewController.view.topAnchor.constraint(equalTo: view.topAnchor),
+            findViewController.view.bottomAnchor.constraint(equalTo: view.bottomAnchor)
         ])
 
         if !cursorPositions.isEmpty {
@@ -110,7 +113,7 @@ extension TextViewController {
                     // Reset content insets and gutter position when appearance changes
                     if let contentInsets = self.contentInsets {
                         self.scrollView.contentInsets = contentInsets
-                        if let searchController = self.searchController, searchController.isShowingFindPanel {
+                        if let findViewController = self.findViewController, findViewController.isShowingFindPanel {
                             self.scrollView.contentInsets.top += FindPanel.height
                         }
                         self.gutterView.frame.origin.y = -self.scrollView.contentInsets.top
@@ -156,10 +159,10 @@ extension TextViewController {
             return nil
         case (commandKey, "f"):
             _ = self.textView.resignFirstResponder()
-            self.searchController?.showFindPanel()
+            self.findViewController?.showFindPanel()
             return nil
         case (0, "\u{1b}"): // Escape key
-            self.searchController?.findPanel.dismiss()
+            self.findViewController?.findPanel.dismiss()
             return nil
         case (_, _):
             return event

Sources/CodeEditSourceEditor/Controller/TextViewController+LoadView.swift

@@ -20,7 +20,7 @@ public class TextViewController: NSViewController {
     // swiftlint:disable:next line_length
     public static let cursorPositionUpdatedNotification: Notification.Name = .init("TextViewController.cursorPositionNotification")
 
-    weak var searchController: FindViewController?
+    weak var findViewController: FindViewController?
 
     var scrollView: NSScrollView!
 
@@ -124,7 +124,11 @@ public class TextViewController: NSViewController {
     public var highlightProviders: [HighlightProviding]
 
     /// Optional insets to offset the text view in the scroll view by.
-    public var contentInsets: NSEdgeInsets?
+    public var contentInsets: NSEdgeInsets? {
+        didSet {
+            findViewController?.topPadding = contentInsets?.top ?? view.safeAreaInsets.top
+        }
+    }
 
     /// Whether or not text view is editable by user
     public var isEditable: Bool {

Sources/CodeEditSourceEditor/Controller/TextViewController.swift

@@ -25,8 +25,13 @@ extension FindViewController {
             setFindPanelConstraintShow()
         }
 
+        // Smooth this animation
+        findPanel.isHidden = false
+        findPanelVerticalConstraint.constant = topPadding - FindPanel.height
+        view.layoutSubtreeIfNeeded()
+
         if animated {
-            withAnimation(updates)
+            withAnimation(updates) { }
         } else {
             updates()
         }
@@ -47,9 +52,12 @@ extension FindViewController {
         }
 
         if animated {
-            withAnimation(updates)
+            withAnimation(updates) { [weak self] in
+                self?.findPanel.isHidden = true
+            }
         } else {
             updates()
+            findPanel.isHidden = true
         }
 
         // Set first responder back to text view
@@ -61,7 +69,7 @@ extension FindViewController {
     /// Runs the `animatable` callback in an animation context with implicit animation enabled.
     /// - Parameter animatable: The callback run in the animation context. Perform layout or view updates in this
     ///                         callback to have them animated.
-    private func withAnimation(_ animatable: () -> Void) {
+    private func withAnimation(_ animatable: () -> Void, onComplete: @escaping () -> Void) {
         NSAnimationContext.runAnimationGroup { animator in
             animator.duration = 0.2
             animator.allowsImplicitAnimation = true
@@ -70,26 +78,28 @@ extension FindViewController {
 
             view.updateConstraints()
             view.layoutSubtreeIfNeeded()
+        } completionHandler: {
+            onComplete()
         }
     }
 
     /// Sets the find panel constraint to show the find panel.
     /// Can be animated using implicit animation.
-    private func setFindPanelConstraintShow() {
+    func setFindPanelConstraintShow() {
         // Update the find panel's top to be equal to the view's top.
-        findPanelVerticalConstraint.constant = view.safeAreaInsets.top
+        findPanelVerticalConstraint.constant = topPadding
         findPanelVerticalConstraint.isActive = true
     }
 
     /// Sets the find panel constraint to hide the find panel.
     /// Can be animated using implicit animation.
-    private func setFindPanelConstraintHide() {
+    func setFindPanelConstraintHide() {
         // Update the find panel's top anchor to be equal to it's negative height, hiding it above the view.
 
         // SwiftUI hates us. It refuses to move views outside of the safe are if they don't have the `.ignoresSafeArea`
         // modifier, but with that modifier on it refuses to allow it to be animated outside the safe area.
         // The only way I found to fix it was to multiply the height by 3 here.
-        findPanelVerticalConstraint.constant = view.safeAreaInsets.top - (FindPanel.height * 3)
+        findPanelVerticalConstraint.constant = topPadding - FindPanel.height
         findPanelVerticalConstraint.isActive = true
     }
 }

Sources/CodeEditSourceEditor/Find/FindViewController+Toggle.swift

@@ -11,12 +11,17 @@ import CodeEditTextView
 /// Creates a container controller for displaying and hiding a find panel with a content view.
 final class FindViewController: NSViewController {
     weak var target: FindPanelTarget?
+
+    var topPadding: CGFloat = 0.0
+
     var childView: NSView
     var findPanel: FindPanel!
     var findMatches: [NSRange] = []
+
     var currentFindMatchIndex: Int = 0
     var findText: String = ""
     var findPanelVerticalConstraint: NSLayoutConstraint!
+
     var isShowingFindPanel: Bool = false
 
     init(target: FindPanelTarget, childView: NSView) {
@@ -92,24 +97,4 @@ final class FindViewController: NSViewController {
             setFindPanelConstraintHide()
         }
     }
-
-    /// Sets the find panel constraint to show the find panel.
-    /// Can be animated using implicit animation.
-    private func setFindPanelConstraintShow() {
-        // Update the find panel's top to be equal to the view's top.
-        findPanelVerticalConstraint.constant = view.safeAreaInsets.top
-        findPanelVerticalConstraint.isActive = true
-    }
-
-    /// Sets the find panel constraint to hide the find panel.
-    /// Can be animated using implicit animation.
-    private func setFindPanelConstraintHide() {
-        // Update the find panel's top anchor to be equal to it's negative height, hiding it above the view.
-
-        // SwiftUI hates us. It refuses to move views outside of the safe are if they don't have the `.ignoresSafeArea`
-        // modifier, but with that modifier on it refuses to allow it to be animated outside the safe area.
-        // The only way I found to fix it was to multiply the height by 3 here.
-        findPanelVerticalConstraint.constant = view.safeAreaInsets.top - (FindPanel.height * 3)
-        findPanelVerticalConstraint.isActive = true
-    }
 }