Make Scroller on Top, Utilize Content Insets

Author: thecoolwinter

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/ContentView.swift

@@ -46,6 +46,7 @@ struct ContentView: View {
                 useThemeBackground: true,
                 highlightProviders: [treeSitterClient],
                 contentInsets: NSEdgeInsets(top: proxy.safeAreaInsets.top, left: 0, bottom: 28.0, right: 0),
+                additionalTextInsets: NSEdgeInsets(top: 1, left: 0, bottom: proxy.size.height * 0.3, right: 0),
                 useSystemCursor: useSystemCursor
             )
             .overlay(alignment: .bottom) {

Sources/CodeEditSourceEditor/Controller/TextViewController+FindPanelTarget.swift

@@ -10,13 +10,11 @@ import CodeEditTextView
 
 extension TextViewController: FindPanelTarget {
     func findPanelWillShow(panelHeight: CGFloat) {
-        scrollView.contentInsets.top += panelHeight
-        gutterView.frame.origin.y = -scrollView.contentInsets.top
+        updateContentInsets()
     }
 
     func findPanelWillHide(panelHeight: CGFloat) {
-        scrollView.contentInsets.top -= panelHeight
-        gutterView.frame.origin.y = -scrollView.contentInsets.top
+        updateContentInsets()
     }
 
     var emphasisManager: EmphasisManager? {

Sources/CodeEditSourceEditor/Controller/TextViewController+LoadView.swift

@@ -38,8 +38,6 @@ extension TextViewController {
         findViewController.view.viewDidMoveToSuperview()
         self.findViewController = findViewController
 
-        findViewController.topPadding = contentInsets?.top
-
         if let _undoManager {
             textView.setUndoManager(_undoManager)
         }
@@ -63,6 +61,7 @@ extension TextViewController {
             NSEvent.removeMonitor(localEventMonitor)
         }
         setUpKeyBindings(eventMonitor: &self.localEvenMonitor)
+        updateContentInsets()
     }
 
     func setUpConstraints() {
@@ -85,8 +84,8 @@ extension TextViewController {
             findViewController.view.topAnchor.constraint(equalTo: view.topAnchor),
             findViewController.view.bottomAnchor.constraint(equalTo: view.bottomAnchor),
 
-            minimapView.topAnchor.constraint(equalTo: scrollView.contentView.safeAreaLayoutGuide.topAnchor),
-            minimapView.bottomAnchor.constraint(equalTo: scrollView.contentView.safeAreaLayoutGuide.bottomAnchor),
+            minimapView.topAnchor.constraint(equalTo: scrollView.contentView.topAnchor),
+            minimapView.bottomAnchor.constraint(equalTo: scrollView.contentView.bottomAnchor),
             minimapXConstraint,
             maxWidthConstraint,
             relativeWidthConstraint,

Sources/CodeEditSourceEditor/Controller/TextViewController+StyleViews.swift

@@ -46,8 +46,6 @@ extension TextViewController {
 
     /// Style the gutter view.
     package func styleGutterView() {
-        // Note: If changing this value, also change in ``findPanelWillShow/Hide()``
-        gutterView.frame.origin.y = -scrollView.contentInsets.top
         gutterView.selectedLineColor = useThemeBackground ? theme.lineHighlight : systemAppearance == .darkAqua
         ? NSColor.quaternaryLabelColor
         : NSColor.selectedTextBackgroundColor.withSystemEffect(.disabled)
@@ -66,19 +64,18 @@ extension TextViewController {
         scrollView.contentView.postsFrameChangedNotifications = true
         scrollView.hasVerticalScroller = true
         scrollView.hasHorizontalScroller = !wrapLines
-
         scrollView.scrollerStyle = .overlay
-
-        updateContentInsets()
     }
 
     package func updateContentInsets() {
         scrollView.contentView.postsBoundsChangedNotifications = true
         if let contentInsets {
             scrollView.automaticallyAdjustsContentInsets = false
             scrollView.contentInsets = contentInsets
+
+            minimapView.scrollView.automaticallyAdjustsContentInsets = false
             minimapView.scrollView.contentInsets.top = contentInsets.top
-            minimapView.scrollView.contentInsets.top = contentInsets.bottom
+            minimapView.scrollView.contentInsets.bottom = contentInsets.bottom
         } else {
             scrollView.automaticallyAdjustsContentInsets = true
             minimapView.scrollView.automaticallyAdjustsContentInsets = true
@@ -95,5 +92,9 @@ extension TextViewController {
 
         scrollView.reflectScrolledClipView(scrollView.contentView)
         minimapView.scrollView.reflectScrolledClipView(minimapView.scrollView.contentView)
+
+        findViewController?.topPadding = contentInsets?.top
+
+        gutterView.frame.origin.y = -scrollView.contentInsets.top
     }
 }

Sources/CodeEditSourceEditor/Controller/TextViewController.swift

@@ -128,7 +128,6 @@ public class TextViewController: NSViewController {
     public var contentInsets: NSEdgeInsets? {
         didSet {
             updateContentInsets()
-            findViewController?.topPadding = contentInsets?.top
         }
     }
 

Sources/CodeEditSourceEditor/Minimap/MinimapLineFragmentView.swift

@@ -119,7 +119,7 @@ final class MinimapLineFragmentView: LineFragmentView {
                 height: 2.0
             )
             context.setFillColor(run.color.cgColor)
-            context.fill(rect.pixelAligned)
+            context.fill(rect)
         }
 
         context.restoreGState()

Sources/CodeEditSourceEditor/Minimap/MinimapView+DocumentVisibleView.swift

@@ -38,14 +38,14 @@ extension MinimapView {
     }
 
     private func setScrollViewPosition(scrollPercentage: CGFloat) {
-        let totalHeight = contentView.frame.height + scrollView.contentInsets.top
-        let topInset = scrollView.contentInsets.top
+        let topInsets = scrollView.contentInsets.top
+        let totalHeight = contentView.frame.height + topInsets
         scrollView.contentView.scroll(
             to: NSPoint(
                 x: scrollView.contentView.frame.origin.x,
                 y: (
-                    scrollPercentage * (totalHeight - (scrollView.documentVisibleRect.height - topInset))
-                ) - topInset
+                    scrollPercentage * (totalHeight - (scrollView.documentVisibleRect.height - topInsets))
+                ) - topInsets
             )
         )
         scrollView.reflectScrolledClipView(scrollView.contentView)

Sources/CodeEditSourceEditor/Minimap/MinimapView+DragVisibleView.swift

@@ -0,0 +1,46 @@
+//
+//  MinimapView+DragVisibleView.swift
+//  CodeEditSourceEditor
+//
+//  Created by Khan Winter on 4/16/25.
+//
+
+import AppKit
+
+extension MinimapView {
+    /// Responds to a drag gesture on the document visible view. Dragging the view scrolls the editor a relative amount.
+    @objc func documentVisibleViewDragged(_ sender: NSPanGestureRecognizer) {
+        guard let editorScrollView = textView?.enclosingScrollView else {
+            return
+        }
+
+        // Convert the drag distance in the minimap to the drag distance in the editor.
+        let translation = sender.translation(in: documentVisibleView)
+        let ratio = if minimapHeight > containerHeight {
+            containerHeight / (textView?.frame.height ?? 0.0)
+        } else {
+            editorToMinimapHeightRatio
+        }
+        let editorTranslation = translation.y / ratio
+        sender.setTranslation(.zero, in: documentVisibleView)
+
+        // Clamp the scroll amount to the content, so we don't scroll crazy far past the end of the document.
+        var newScrollViewY = editorScrollView.contentView.bounds.origin.y - editorTranslation
+        // Minimum Y value is the top of the scroll view
+        newScrollViewY = max(-editorScrollView.contentInsets.top, newScrollViewY)
+        newScrollViewY = min( // Max y value needs to take into account the editor overscroll
+            editorScrollView.documentMaxOriginY
+            - editorScrollView.contentInsets.top
+            + editorScrollView.contentInsets.bottom,
+            newScrollViewY
+        )
+
+        editorScrollView.contentView.scroll(
+            to: NSPoint(
+                x: editorScrollView.contentView.bounds.origin.x,
+                y: newScrollViewY
+            )
+        )
+        editorScrollView.reflectScrolledClipView(editorScrollView.contentView)
+    }
+}

Sources/CodeEditSourceEditor/Minimap/MinimapView.swift

@@ -17,7 +17,7 @@ class MinimapView: FlippedNSView {
     let contentView: FlippedNSView
     /// The box displaying the visible region on the minimap.
     let documentVisibleView: NSView
-
+    /// A small gray line on the left of the minimap distinguishing it from the editor.
     let separatorView: NSView
 
     var documentVisibleViewDragGesture: NSPanGestureRecognizer?
@@ -52,6 +52,8 @@ class MinimapView: FlippedNSView {
         - (textView?.enclosingScrollView?.contentInsets.vertical ?? 0.0)
     }
 
+    // MARK: - Init
+
     init(textView: TextView, theme: EditorTheme) {
         self.textView = textView
         self.theme = theme
@@ -111,6 +113,8 @@ class MinimapView: FlippedNSView {
         setUpListeners()
     }
 
+    // MARK: - Constraints
+
     private func setUpConstraints() {
         NSLayoutConstraint.activate([
             // Constrain to all sides
@@ -135,6 +139,8 @@ class MinimapView: FlippedNSView {
         ])
     }
 
+    // MARK: - Scroll listeners
+
     private func setUpListeners() {
         guard let editorScrollView = textView?.enclosingScrollView else { return }
         // Need to listen to:
@@ -184,35 +190,4 @@ class MinimapView: FlippedNSView {
             return super.hitTest(point)
         }
     }
-
-    /// Responds to a drag gesture on the document visible view. Dragging the view scrolls the editor a relative amount.
-    @objc func documentVisibleViewDragged(_ sender: NSPanGestureRecognizer) {
-        guard let editorScrollView = textView?.enclosingScrollView else {
-            return
-        }
-
-        let translation = sender.translation(in: documentVisibleView)
-        let ratio = if minimapHeight > containerHeight {
-            containerHeight / (textView?.frame.height ?? 0.0)
-        } else {
-            editorToMinimapHeightRatio
-        }
-        let editorTranslation = translation.y / ratio
-        sender.setTranslation(.zero, in: documentVisibleView)
-
-        var newScrollViewY = editorScrollView.contentView.bounds.origin.y - editorTranslation
-        newScrollViewY = max(-editorScrollView.contentInsets.top, newScrollViewY)
-        newScrollViewY = min(
-            editorScrollView.documentMaxOriginY - editorScrollView.contentInsets.top,
-            newScrollViewY
-        )
-
-        editorScrollView.contentView.scroll(
-            to: NSPoint(
-                x: editorScrollView.contentView.bounds.origin.x,
-                y: newScrollViewY
-            )
-        )
-        editorScrollView.reflectScrolledClipView(editorScrollView.contentView)
-    }
 }