Repository navigation
[BUG] Tooltip calls build when mouse enters/leaves Flutter window #117627
Description
Bug Summary
When mouse enters/leaves the flutter app window, Tooltip widget rebuilds its child unnecessarily. The mouse pointer doesn't even need to enter the Tooltip area, just by entering or leaving the app window, all Tooltip widgets rebuild their children.
Demonstration
Sample code is provided below. There's a print() in the builder which is the child of the Tooltip. Each time mouse enters or leaves the app, the print() is getting called and logs "rebuilding!". (My original code had TweenAnimationBuilder and it was repeating the animation over and over but I've stripped it down to a simple builder to demonstrate.)
25.12.2022_11.40.20_REC.mp4
Sample code
import 'package:flutter/material.dart';
void main() {
runApp(const MyApp());
}
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Flutter Demo',
theme: ThemeData(
primarySwatch: Colors.blue,
),
home: const MyHomePage(title: 'Flutter Tooltip bug'),
);
}
}
class MyHomePage extends StatefulWidget {
const MyHomePage({super.key, required this.title});
final String title;
@override
State<MyHomePage> createState() => _MyHomePageState();
}
class _MyHomePageState extends State<MyHomePage> {
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text(widget.title),
),
body: Center(
child: Container(
decoration:
BoxDecoration(border: Border.all(width: 1, color: Colors.blue)),
child: SizedBox(
height: 100,
width: 100,
child: Tooltip(
message: 'Some label',
child: Builder(
builder: (BuildContext context) {
// ignore: avoid_print
print('rebuilding!');
return const Icon(
Icons.abc_outlined,
size: 100,
color: Colors.red,
);
},
),
),
),
),
),
);
}
}
Flutter Doctor
Doctor summary (to see all details, run flutter doctor -v):
[√] Flutter (Channel stable, 3.3.10, on Microsoft Windows [Version 10.0.22621.963], locale en-US)
[√] Android toolchain - develop for Android devices (Android SDK version 32.1.0-rc1)
[√] Chrome - develop for the web
[√] Visual Studio - develop for Windows (Visual Studio Community 2022 17.3.6)
[√] Android Studio (version 2021.2)
[√] VS Code, 64-bit edition (version 1.74.1)
[√] Connected device (4 available)
[√] HTTP Host Availability
• No issues found!
Activity
huycozy commentedon Dec 26, 2022
@asmith20002 thanks for your report. This issue is reproducible on the latest
stableandmasterchannels. It seems only to happen on desktop app as below since I can't see the issue on Web app.✅: No Issue ❌: Issue reproduced
flutter doctor -v (stable and master)
[✓] Flutter (Channel stable, 3.3.10, on macOS 13.0.1 22A400 darwin-x64, locale en-VN) • Flutter version 3.3.10 on channel stable at /Users/huynq/Documents/GitHub/flutter • Upstream repository https://github.com/flutter/flutter.git • Framework revision 135454af32 (13 hours ago), 2022-12-15 07:36:55 -0800 • Engine revision 3316dd8728 • Dart version 2.18.6 • DevTools version 2.15.0 [✓] Android toolchain - develop for Android devices (Android SDK version 31.0.0) • Android SDK at /Users/huynq/Library/Android/sdk • Platform android-33, build-tools 31.0.0 • ANDROID_HOME = /Users/huynq/Library/Android/sdk • Java binary at: /Applications/Android Studio.app/Contents/jre/Contents/Home/bin/java • Java version OpenJDK Runtime Environment (build 11.0.13+0-b1751.21-8125866) • All Android licenses accepted. [✓] Xcode - develop for iOS and macOS (Xcode 14.1) • Xcode at /Applications/Xcode.app/Contents/Developer • Build 14B47b • CocoaPods version 1.11.3 [✓] Chrome - develop for the web • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome [✓] Android Studio (version 2021.3) • Android Studio at /Applications/Android Studio.app/Contents • Flutter plugin can be installed from: 🔨 https://plugins.jetbrains.com/plugin/9212-flutter • Dart plugin can be installed from: 🔨 https://plugins.jetbrains.com/plugin/6351-dart • Java version OpenJDK Runtime Environment (build 11.0.13+0-b1751.21-8125866) [✓] IntelliJ IDEA Community Edition (version 2022.1.1) • IntelliJ at /Users/huynq/Library/Application Support/JetBrains/Toolbox/apps/IDEA-C/ch-0/221.5591.52/IntelliJ IDEA CE.app • Flutter plugin can be installed from: 🔨 https://plugins.jetbrains.com/plugin/9212-flutter • Dart plugin can be installed from: 🔨 https://plugins.jetbrains.com/plugin/6351-dart [✓] VS Code (version 1.73.1) • VS Code at /Applications/Visual Studio Code.app/Contents • Flutter extension version 3.54.0 [✓] Connected device (3 available) • SM T225 (mobile) • R9JT3004VRJ • android-arm64 • Android 12 (API 31) • macOS (desktop) • macos • darwin-x64 • macOS 13.0.1 22A400 darwin-x64 • Chrome (web) • chrome • web-javascript • Google Chrome 108.0.5359.124 [✓] HTTP Host Availability • All required HTTP hosts are available • No issues found!asmith20002 commentedon Jan 26, 2023
#119199 thanks for the fix.
Moreover on this issue:
If there are
CustomPaints in the code, thoseCustomPaintbuilders get called along withtooltips children. Again it doesn't matter if theCustomPaintis insideTooltipor not. Even the ones outside and completely unrelated get rebuilt again. (shouldRepaintis set to false)Same sample code with CustomPaint added
cliftonlabrum commentedon Feb 1, 2023
Just ran into this same issue. This is particularly noticeable when your widget has an
Image.memory()widget in it since it will redraw the image and it looks like it's reloading the picture on each mouse reentry. 😅Remove Tooltip mouse tracker listener & update hovering/MouseRegion l…
github-actions commentedon Jun 8, 2023
This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of
flutter doctor -vand a minimal reproduction of the issue.Remove Tooltip mouse tracker listener & update hovering/MouseRegion l…