Skip to content

fix: stop scroll ticks cancelling the floating toolbar's pending show #1222

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

Open
matanrotman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: stop scroll ticks cancelling the floating toolbar's pending show #1222

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
33 changes: 24 additions & 9 deletions lib/src/editor/toolbar/desktop/floating_toolbar.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ class _FloatingToolbarState extends State<FloatingToolbar>

@override
void dispose() {
Debounce.cancel(_debounceKey);
Debounce.cancel(_selectionDebounceKey);
Debounce.cancel(_scrollDebounceKey);

_toolbarContainer?.remove();
_toolbarContainer?.dispose();
Expand Down Expand Up @@ -128,7 +129,7 @@ class _FloatingToolbarState extends State<FloatingToolbar>
void didChangeMetrics() {
super.didChangeMetrics();
hasMetricsChanged = true;
_showAfterDelay(isMetricsChanged: true);
_showAfterDelay(_selectionDebounceKey, isMetricsChanged: true);
}

@override
Expand Down Expand Up @@ -158,6 +159,7 @@ class _FloatingToolbarState extends State<FloatingToolbar>
} else if (!disableToolbar) {
// uses debounce to avoid the computing the rects too frequently.
_showAfterDelay(
_selectionDebounceKey,
duration: const Duration(milliseconds: 200),
isMetricsChanged: hasMetricsChanged,
);
Expand All @@ -168,27 +170,40 @@ class _FloatingToolbarState extends State<FloatingToolbar>
void _onScrollPositionChanged() {
_clear();

// TODO: optimize the toolbar showing logic, making it more smooth.
// A quick idea: based on the scroll controller's offset to display the toolbar.
_showAfterDelay();
// Auto-scroll drives this from its own ticker, ahead of the layout pass
// that repositions the scrolled content. Defer so the toolbar measures
// settled geometry instead of the previous frame's.
WidgetsBinding.instance.addPostFrameCallback((_) {
if (!mounted) return;
// TODO: optimize the toolbar showing logic, making it more smooth.
// A quick idea: based on the scroll controller's offset to display the toolbar.
_showAfterDelay(_scrollDebounceKey);
});
}

final String _debounceKey = 'show the toolbar';
// Selection- and scroll-triggered shows debounce separately. On a shared key
// the last caller won, so a scroll tick could cancel a pending 200ms
// selection-driven show — and the two interleave during any drag that
// auto-scrolls.
final String _selectionDebounceKey = 'show the toolbar - selection';
final String _scrollDebounceKey = 'show the toolbar - scroll';

void _clear() {
Debounce.cancel(_debounceKey);
Debounce.cancel(_selectionDebounceKey);
Debounce.cancel(_scrollDebounceKey);

_toolbarContainer?.remove();
_toolbarContainer = null;
}

void _showAfterDelay({
void _showAfterDelay(
String debounceKey, {
Duration duration = Duration.zero,
bool isMetricsChanged = false,
}) {
// uses debounce to avoid the computing the rects too frequently.
Debounce.debounce(
_debounceKey,
debounceKey,
duration,
() {
_clear(); // clear the previous toolbar.
Expand Down