Parameterizing AutoScrollController in default editor

Author: jmatth

super_editor/lib/src/default_editor/super_editor.dart

@@ -22,7 +22,6 @@ import 'package:super_editor/src/default_editor/list_items.dart';
 import 'package:super_editor/src/default_editor/tasks.dart';
 import 'package:super_editor/src/infrastructure/_logging.dart';
 import 'package:super_editor/src/infrastructure/content_layers.dart';
-import 'package:super_editor/src/infrastructure/document_gestures.dart';
 import 'package:super_editor/src/infrastructure/documents/document_scaffold.dart';
 import 'package:super_editor/src/infrastructure/documents/document_scroller.dart';
 import 'package:super_editor/src/infrastructure/documents/selection_leader_document_layer.dart';
@@ -132,7 +131,7 @@ class SuperEditor extends StatefulWidget {
     this.iOSToolbarBuilder,
     this.createOverlayControlsClipper,
     this.plugins = const {},
-    this.scrollOff = AxisOffset.zero,
+    this.autoScrollController,
     this.debugPaint = const DebugPaintConfig(),
     this.documentLayoutBuilder,
   })  : stylesheet = stylesheet ?? defaultStylesheet,
@@ -142,10 +141,6 @@ class SuperEditor extends StatefulWidget {
             : [...defaultComponentBuilders, const UnknownComponentBuilder()],
         super(key: key);
 
-  /// How far the selection extent can be from the top and bottom before triggering auto-scroll behavior. Defaults to
-  /// zero for both top and bottom, so scrolling will only take place if the caret would leave the viewport.
-  final AxisOffset scrollOff;
-
   /// [FocusNode] for the entire `SuperEditor`.
   final FocusNode? focusNode;
 
@@ -169,6 +164,8 @@ class SuperEditor extends StatefulWidget {
   /// `Scrollable`.
   final ScrollController? scrollController;
 
+  final AutoScrollController? autoScrollController;
+
   /// [GlobalKey] that's bound to the [DocumentLayout] within
   /// this `SuperEditor`.
   ///
@@ -398,9 +395,7 @@ class SuperEditorState extends State<SuperEditor> {
     _composer = widget.composer;
 
     _scrollController = widget.scrollController ?? ScrollController();
-    _autoScrollController = AutoScrollController(
-      selectionExtentAutoScrollBoundary: widget.scrollOff,
-    );
+    _autoScrollController = widget.autoScrollController ?? AutoScrollController();
 
     _docLayoutKey = widget.documentLayoutKey ?? GlobalKey();
 
@@ -461,6 +456,13 @@ class SuperEditorState extends State<SuperEditor> {
       _scrollController = widget.scrollController ?? ScrollController();
     }
 
+    if (widget.autoScrollController != oldWidget.autoScrollController) {
+      if (oldWidget.autoScrollController == null) {
+        _autoScrollController.dispose();
+      }
+      _autoScrollController = widget.autoScrollController ?? AutoScrollController();
+    }
+
     _recomputeIfLayoutShouldShowCaret();
   }
 
@@ -479,6 +481,10 @@ class SuperEditorState extends State<SuperEditor> {
       _focusNode.dispose();
     }
 
+    if (widget.autoScrollController == null) {
+      _autoScrollController.dispose();
+    }
+
     super.dispose();
   }
 

super_editor/lib/super_editor.dart

@@ -50,6 +50,7 @@ export 'src/default_editor/text_tokenizing/pattern_tags.dart';
 export 'src/default_editor/text_tokenizing/tags.dart';
 export 'src/default_editor/text_tokenizing/stable_tags.dart';
 export 'src/default_editor/unknown_component.dart';
+export 'src/default_editor/document_scrollable.dart';
 
 // Document operations used by SuperEditor and/or SuperReader,
 // also made available for public use.