Hide nearby cursor suggestion when the line of code is out of frame

Author: intitni

Core/Sources/SuggestionWidget/SuggestionPanelView.swift

@@ -4,14 +4,17 @@ import SwiftUI
 @MainActor
 final class SuggestionPanelDisplayController: ObservableObject {
     @Published var alignTopToAnchor = false
+    @Published var isPanelOutOfFrame: Bool = false
     @Published var isPanelDisplayed: Bool = false
 
     init(
         alignTopToAnchor: Bool = false,
+        isPanelOutOfFrame: Bool = false,
         isPanelDisplayed: Bool = false
     ) {
         self.alignTopToAnchor = alignTopToAnchor
         self.isPanelDisplayed = isPanelDisplayed
+        self.isPanelOutOfFrame = isPanelOutOfFrame
     }
 }
 
@@ -45,7 +48,9 @@ struct SuggestionPanelView: View {
                     }
                     .frame(maxWidth: .infinity, maxHeight: Style.inlineSuggestionMaxHeight)
                     .fixedSize(horizontal: false, vertical: true)
-                    .allowsHitTesting(displayController.isPanelDisplayed)
+                    .allowsHitTesting(
+                        displayController.isPanelDisplayed && !displayController.isPanelOutOfFrame
+                    )
                 }
             }
             .frame(maxWidth: .infinity)
@@ -59,6 +64,7 @@ struct SuggestionPanelView: View {
         .preferredColorScheme(viewModel.colorScheme)
         .opacity({
             guard displayController.isPanelDisplayed else { return 0 }
+            guard !displayController.isPanelOutOfFrame else { return 0 }
             guard viewModel.content != nil else { return 0 }
             return 1
         }())
@@ -72,6 +78,12 @@ struct SuggestionPanelView: View {
             .easeInOut(duration: 0.2),
             value: displayController.isPanelDisplayed
         )
+        .animation(
+            featureFlag: \.animationBCrashSuggestion,
+            .easeInOut(duration: 0.2),
+            value: displayController.isPanelOutOfFrame
+        )
         .frame(maxWidth: Style.inlineSuggestionMinWidth, maxHeight: Style.inlineSuggestionMaxHeight)
     }
 }
+

Core/Sources/SuggestionWidget/SuggestionWidgetController.swift

@@ -537,15 +537,18 @@ extension SuggestionWidgetController {
             sharedPanelDisplayController.alignTopToAnchor = widgetLocation.defaultPanelLocation
                 .alignPanelTop
 
-            let suggestionPanelLocation = widgetLocation.suggestionPanelLocation ?? widgetLocation
-                .defaultPanelLocation
-            suggestionWindow.setFrame(
-                suggestionPanelLocation.frame,
-                display: false,
-                animate: animated
-            )
-            suggestionPanelDisplayController.alignTopToAnchor = suggestionPanelLocation
-                .alignPanelTop
+            if let suggestionPanelLocation = widgetLocation.suggestionPanelLocation {
+                suggestionWindow.setFrame(
+                    suggestionPanelLocation.frame,
+                    display: false,
+                    animate: animated
+                )
+                suggestionPanelDisplayController.isPanelOutOfFrame = false
+                suggestionPanelDisplayController.alignTopToAnchor = suggestionPanelLocation
+                    .alignPanelTop
+            } else {
+                suggestionPanelDisplayController.isPanelOutOfFrame = true
+            }
 
             if detachChat {
                 if chatWindow.alphaValue == 0 {

Core/Sources/SuggestionWidget/WidgetPositionStrategy.swift

@@ -224,6 +224,11 @@ enum UpdateLocationStrategy {
             guard let selectionFrame = UpdateLocationStrategy
                 .getSelectionFirstLineFrame(editor: editor) else { return nil }
 
+            // hide it when the line of code is outside of the editor visible rect
+            if selectionFrame.maxY < editorFrame.minY || selectionFrame.minY > editorFrame.maxY {
+                return nil
+            }
+
             let proposedY = mainScreen.frame.height - selectionFrame.maxY
             let proposedX = selectionFrame.maxX - 40
             let maxY = max(
@@ -235,7 +240,11 @@ enum UpdateLocationStrategy {
                 activeScreen.frame.maxY - 4
             )
 
-            let alignPanelTopToAnchor = y - Style.inlineSuggestionMaxHeight >= activeScreen.frame.minY
+            // align panel to top == place under the selection frame.
+            // we initially try to place it at the bottom side, but if there is no enough space
+            // we move it to the top of the selection frame.
+            let alignPanelTopToAnchor = y - Style.inlineSuggestionMaxHeight
+                >= activeScreen.frame.minY
 
             let caseIgnoreCompletionPanel = {
                 (alignPanelTopToAnchor: Bool) -> WidgetLocation.PanelLocation? in
@@ -246,7 +255,7 @@ enum UpdateLocationStrategy {
                     return activeScreen.frame.maxX - Style.inlineSuggestionMinWidth
                 }()
                 if alignPanelTopToAnchor {
-                    // case: present below selection
+                    // case: present under selection
                     return .init(
                         frame: .init(
                             x: x,
@@ -257,6 +266,7 @@ enum UpdateLocationStrategy {
                         alignPanelTop: alignPanelTopToAnchor
                     )
                 } else {
+                    // case: present above selection
                     return .init(
                         frame: .init(
                             x: x,
@@ -275,8 +285,10 @@ enum UpdateLocationStrategy {
 
                 switch (completionPanelBelowCursor, alignPanelTopToAnchor) {
                 case (true, false), (false, true):
+                    // case: different position, place the suggestion as it should be
                     return caseIgnoreCompletionPanel(alignPanelTopToAnchor)
                 case (true, true), (false, false):
+                    // case: same position, place the suggestion next to the completion panel
                     let y = completionPanelBelowCursor
                         ? y - Style.inlineSuggestionMaxHeight
                         : y + selectionFrame.height - Style.widgetPadding
@@ -303,6 +315,7 @@ enum UpdateLocationStrategy {
                             alignPanelTop: alignPanelTopToAnchor
                         )
                     }
+                    // case: no enough horizontal space, place the suggestion on the other side
                     return caseIgnoreCompletionPanel(!alignPanelTopToAnchor)
                 }
             }