Add documentation

Author: tom-ludwig

Sources/CodeEditTextView/TextView/TextView+ScrollToVisible.swift

@@ -37,7 +37,15 @@ extension TextView {
         }
     }
 
-    public func scrollToRange(_ range: NSRange) {
+
+    /// Scrolls the view to the specified range.
+    ///
+    /// - Parameters:
+    ///   - range: The range to scroll to.
+    ///   - center: A flag that determines if the range should be centered in the view. Defaults to `true`.
+    ///
+    /// If `center` is `true`, the range will be centered in the visible area. If `center` is `false`, the range will be aligned at the top-left of the view.
+    public func scrollToRange(_ range: NSRange, center: Bool = true) {
         guard let scrollView else { return }
 
         guard let boundingRect = layoutManager.rectForOffset(range.location) else { return }
@@ -47,15 +55,23 @@ extension TextView {
             return // No scrolling needed
         }
 
-        // Calculate the target offset to center the range in the view
-        let targetOffset = CGPoint(
-            x: max(boundingRect.midX - visibleRect.width / 2, 0),
-            y: max(boundingRect.midY - visibleRect.height / 2, 0)
-        )
+        // Calculate the target offset based on the center flag
+        let targetOffset: CGPoint
+        if center {
+            targetOffset = CGPoint(
+                x: max(boundingRect.midX - visibleRect.width / 2, 0),
+                y: max(boundingRect.midY - visibleRect.height / 2, 0)
+            )
+        } else {
+            targetOffset = CGPoint(
+                x: max(boundingRect.origin.x, 0),
+                y: max(boundingRect.origin.y, 0)
+            )
+        }
 
         var lastFrame: CGRect = .zero
 
-        // Set a timeout to avoid a infinite loop
+        // Set a timeout to avoid an infinite loop
         let timeout: TimeInterval = 0.5
         let startTime = Date()
 
@@ -69,7 +85,7 @@ extension TextView {
             selectionManager.drawSelections(in: visibleRect)
         }
 
-        // Scroll to make the range appear in the middle of the screen
+        // Scroll to make the range appear at the desired position
         if lastFrame != .zero {
             let animated = false // feature flag
             if animated {
@@ -83,7 +99,6 @@ extension TextView {
             }
         }
     }
-
     /// Get the selection that should be scrolled to visible for the current text selection.
     /// - Returns: The the selection to scroll to.
     private func getSelection() -> TextSelection? {