Skip to content

Assert editor is in scrollable view shen showCursor or enableSelectionInteraction is true #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amantoux merged 1 commit into from
Sep 19, 2025
Merged

Assert editor is in scrollable view shen showCursor or enableSelectionInteraction is true #548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions packages/fleather/lib/src/widgets/editor.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ class FleatherEditor extends StatefulWidget {
///
/// When set to `false` the editor always expands to fit the entire content
/// of the document and should normally be placed as a child of another
/// scrollable widget, otherwise the content may be clipped.
/// scrollable widget, otherwise the content may be clipped and an
/// error will be thrown if [enableInteractiveSelection] is `true`.
///
/// Set to `true` by default.
final bool scrollable;
Expand Down Expand Up @@ -1626,7 +1627,24 @@ class RawEditorState extends EditorState
bool _showCaretOnScreenScheduled = false;

void _showCaretOnScreen([bool withAnimation = true]) {
if (!widget.showCursor || _showCaretOnScreenScheduled) {
assert(
widget.enableInteractiveSelection
? _scrollController.positions.isNotEmpty
: true,
'ScrollController not attached to any scroll views. '
'When editor configured with scrollable = false and '
'enableInteractiveSelection = true, make sure the editor is the child '
'of a Scrollable widget.');
assert(
widget.showCursor ? _scrollController.positions.isNotEmpty : true,
'ScrollController not attached to any scroll views. '
'When editor configured with scrollable = false and '
'showCursor = true, make sure the editor is the child '
'of a Scrollable widget.');

if (!widget.showCursor ||
!widget.enableInteractiveSelection ||
_showCaretOnScreenScheduled) {
return;
}

Expand Down
6 changes: 5 additions & 1 deletion packages/fleather/test/widgets/editor_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,11 @@ void main() {
// Scrollable forces expansion of editor
scrollable: false,
readOnly: true,
// We don't want to show cursor (will cause error if not scrollable)
// We don't want to enable selection interactions
// (will cause error if not scrollable)
enableSelectionInteraction: false,
// We don't want to show cursor
// (will cause error if not scrollable)
showCursor: false,
textWidthBasis: TextWidthBasis.longestLine,
);
Expand Down