Skip to content

fix: Cancel taps that start inside the component and end outside #3805

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
spydon merged 2 commits into from
Feb 8, 2026
+62 −0
Merged

fix: Cancel taps that start inside the component and end outside #3805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ca77fb
Cancel taps that start inside the component and end outside
8symbols Feb 8, 2026
29c0afb
Add test for tap with different start and end position inside component
8symbols Feb 8, 2026
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
2 changes: 2 additions & 0 deletions packages/flame/lib/src/events/flame_game_mixins/multi_tap_dispatcher.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ class MultiTapDispatcher extends Component implements MultiTapListener {
},
deliverToAll: true,
);

_tapCancelImpl(event.toTapCancel());
}

/// Called when there was an [onTapDown] event previously, but the [onTapUp]
Expand Down
3 changes: 3 additions & 0 deletions packages/flame/lib/src/events/messages/tap_up_event.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import 'package:flame/extensions.dart';
import 'package:flame/src/events/messages/position_event.dart';
import 'package:flame/src/events/messages/tap_cancel_event.dart';
import 'package:flame/src/events/messages/tap_down_event.dart';
import 'package:flutter/gestures.dart';

Expand All @@ -23,6 +24,8 @@ class TapUpEvent extends PositionEvent<TapUpDetails> {

final PointerDeviceKind deviceKind;

TapCancelEvent toTapCancel() => TapCancelEvent(pointerId);

@override
String toString() =>
'TapUpEvent(canvasPosition: $canvasPosition, '
Expand Down
57 changes: 57 additions & 0 deletions packages/flame/test/events/component_mixins/tap_callbacks_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,63 @@ void main() {
},
);

testWidgets(
'tap that starts inside the component and ends outside is cancelled',
(tester) async {
final component = _TapCallbacksComponent()
..x = 10
..y = 10
..width = 10
..height = 10;
final game = FlameGame(children: [component]);
await tester.pumpWidget(GameWidget(game: game));
await tester.pump();
await tester.pump();
expect(component.isMounted, isTrue);

final gesture = await tester.startGesture(const Offset(10, 10));
await tester.pump(const Duration(milliseconds: 500));
await gesture.moveTo(const Offset(10, 9));
await tester.pump(const Duration(milliseconds: 500));
await gesture.up();

await tester.pump();

expect(component.tapDownEvent, equals(1));
expect(component.tapUpEvent, equals(0));
expect(component.tapCancelEvent, equals(1));
},
);

testWidgets(
'tap that starts and ends in different positions'
' inside the component is handled',
(tester) async {
final component = _TapCallbacksComponent()
..x = 10
..y = 10
..width = 10
..height = 10;
final game = FlameGame(children: [component]);
await tester.pumpWidget(GameWidget(game: game));
await tester.pump();
await tester.pump();
expect(component.isMounted, isTrue);

final gesture = await tester.startGesture(const Offset(10, 10));
await tester.pump(const Duration(milliseconds: 500));
await gesture.moveTo(const Offset(10, 11));
await tester.pump(const Duration(milliseconds: 500));
await gesture.up();

await tester.pump();

expect(component.tapDownEvent, equals(1));
expect(component.tapUpEvent, equals(1));
expect(component.tapCancelEvent, equals(0));
},
);

testWithGame(
'make sure the FlameGame can registers TapCallback on itself',
_TapCallbacksGame.new,
Expand Down