No Overlay widget found exception When showing snackbar

[stan-at-work]

Steps to reproduce

When hovering over a tooltip, i get the following assertion:

flutter: ══╡ EXCEPTION CAUGHT BY WIDGETS LIBRARY ╞═══════════════════════════════════════════════════════════
flutter: The following assertion was thrown building Tooltip("Close", dirty, dependencies: [_InheritedTheme,
flutter: _LocalizationsScope-[GlobalKey#e4586]], state: TooltipState#85ae0):
flutter: No Overlay widget found.
flutter: Tooltip widgets require an Overlay widget ancestor within the closest LookupBoundary.
flutter: An overlay lets widgets float on top of other widget children.
flutter: To introduce an Overlay widget, you can either directly include one, or use a widget that contains
flutter: an Overlay itself, such as a Navigator, WidgetApp, MaterialApp, or CupertinoApp.
flutter: The specific widget that could not find a Overlay ancestor was:
flutter:   Tooltip
flutter: The ancestors of this widget were:
flutter:   ...
flutter:   Semantics
flutter:   Align
flutter:   Padding
flutter:   IconTheme
flutter:   Builder
flutter:   ...
flutter:
flutter: The relevant error-causing widget was:
flutter:   Scaffold

Currently the tree looks like this:

This indicates that there are currently 2 Material widgets present that could provide a Overlay.

The error is triggered at the following level:

I can't find any reason why this assertion pops up.

This issue started after i upgraded to flutter 3.22 (latest) from 3.19.x

Expected results

No error like flutter 3.19.x

Actual results

I get an error when trying to click/hover over a button that has a toolTip in it.

Code sample

/

Screenshots or Video

Logs

Logs

flutter: ══╡ EXCEPTION CAUGHT BY WIDGETS LIBRARY ╞═══════════════════════════════════════════════════════════
flutter: The following assertion was thrown building Tooltip("Close", dirty, dependencies: [_InheritedTheme,
flutter: _LocalizationsScope-[GlobalKey#e4586]], state: TooltipState#a606f):
flutter: No Overlay widget found.
flutter: Tooltip widgets require an Overlay widget ancestor within the closest LookupBoundary.
flutter: An overlay lets widgets float on top of other widget children.
flutter: To introduce an Overlay widget, you can either directly include one, or use a widget that contains
flutter: an Overlay itself, such as a Navigator, WidgetApp, MaterialApp, or CupertinoApp.
flutter: The specific widget that could not find a Overlay ancestor was:
flutter:   Tooltip
flutter: The ancestors of this widget were:
flutter:   ...
flutter:   Semantics
flutter:   Align
flutter:   Padding
flutter:   IconTheme
flutter:   Builder
flutter:   ...
flutter:
flutter: The relevant error-causing widget was:
flutter:   Scaffold
flutter:
flutter:
flutter: When the exception was thrown, this was the stack:
flutter: #0      debugCheckHasOverlay.<anonymous closure>
flutter: #1      debugCheckHasOverlay
flutter: #2      TooltipState.build
flutter: #3      StatefulElement.build
flutter: #4      ComponentElement.performRebuild
flutter: #5      StatefulElement.performRebuild
flutter: #6      Element.rebuild
flutter: #7      ComponentElement._firstBuild
flutter: #8      StatefulElement._firstBuild
flutter: #9      ComponentElement.mount
flutter: ...     Normal element mounting (193 frames)
flutter: #202    Element.inflateWidget
flutter: #203    MultiChildRenderObjectElement.inflateWidget
flutter: #204    MultiChildRenderObjectElement.mount
flutter: #205    Element.inflateWidget
flutter: #206    MultiChildRenderObjectElement.inflateWidget
flutter: #207    MultiChildRenderObjectElement.mount
flutter: ...     Normal element mounting (234 frames)
flutter: #441    Element.inflateWidget
flutter: #442    MultiChildRenderObjectElement.inflateWidget
flutter: #443    Element.updateChild
flutter: #444    Element.updateChildren
flutter: #445    MultiChildRenderObjectElement.update
flutter: #446    Element.updateChild
flutter: #447    ComponentElement.performRebuild
flutter: #448    Element.rebuild
flutter: #449    ProxyElement.update
flutter: #450    Element.updateChild
flutter: #451    ComponentElement.performRebuild
flutter: #452    StatefulElement.performRebuild
flutter: #453    Element.rebuild
flutter: #454    StatefulElement.update
flutter: #455    Element.updateChild
flutter: #456    ComponentElement.performRebuild
flutter: #457    StatefulElement.performRebuild
flutter: #458    Element.rebuild
flutter: #459    StatefulElement.update
flutter: #460    Element.updateChild
flutter: #461    ComponentElement.performRebuild
flutter: #462    Element.rebuild
flutter: #463    ProxyElement.update
flutter: #464    Element.updateChild
flutter: #465    ComponentElement.performRebuild
flutter: #466    StatefulElement.performRebuild
flutter: #467    Element.rebuild
flutter: #468    StatefulElement.update
flutter: #469    Element.updateChild
flutter: #470    SingleChildRenderObjectElement.update
flutter: #471    Element.updateChild
flutter: #472    ComponentElement.performRebuild
flutter: #473    Element.rebuild
flutter: #474    ProxyElement.update
flutter: #475    Element.updateChild
flutter: #476    SingleChildRenderObjectElement.update
flutter: #477    Element.updateChild
flutter: #478    ComponentElement.performRebuild
flutter: #479    StatefulElement.performRebuild
flutter: #480    Element.rebuild
flutter: #481    StatefulElement.update
flutter: #482    Element.updateChild
flutter: #483    ComponentElement.performRebuild
flutter: #484    StatefulElement.performRebuild
flutter: #485    Element.rebuild
flutter: #486    StatefulElement.update
flutter: #487    Element.updateChild
flutter: #488    ComponentElement.performRebuild
flutter: #489    Element.rebuild
flutter: #490    ProxyElement.update
flutter: #491    Element.updateChild
flutter: #492    ComponentElement.performRebuild
flutter: #493    Element.rebuild
flutter: #494    ProxyElement.update
flutter: #495    Element.updateChild
flutter: #496    ComponentElement.performRebuild
flutter: #497    Element.rebuild
flutter: #498    ProxyElement.update
flutter: #499    Element.updateChild
flutter: #500    ComponentElement.performRebuild
flutter: #501    StatefulElement.performRebuild
flutter: #502    Element.rebuild
flutter: #503    StatefulElement.update
flutter: #504    Element.updateChild
flutter: #505    ComponentElement.performRebuild
flutter: #506    Element.rebuild
flutter: #507    ProxyElement.update
flutter: #508    Element.updateChild
flutter: #509    ComponentElement.performRebuild
flutter: #510    StatefulElement.performRebuild
flutter: #511    Element.rebuild
flutter: #512    BuildOwner.buildScope
flutter: #513    WidgetsBinding.drawFrame
flutter: #514    RendererBinding._handlePersistentFrameCallback
flutter: #515    SchedulerBinding._invokeFrameCallback
flutter: #516    SchedulerBinding.handleDrawFrame
flutter: #517    SchedulerBinding._handleDrawFrame
flutter: #521    _invoke (dart:ui/hooks.dart:314:10)
flutter: #522    PlatformDispatcher._drawFrame (dart:ui/platform_dispatcher.dart:419:5)
flutter: #523    _drawFrame (dart:ui/hooks.dart:283:31)
flutter: (elided 3 frames from dart:async)
flutter:
flutter: ════════════════════════════════════════════════════════════════════════════════════════════════════

Flutter Doctor output

Doctor output

[√] Flutter (Channel stable, 3.22.0, on Microsoft Windows [Version 10.0.19045.4291], locale nl-BE)
    • Flutter version 3.22.0 on channel stable at C:\Users\xxx\flutter
    • Upstream repository https://github.com/flutter/flutter.git
    • Framework revision 5dcb86f68f (5 days ago), 2024-05-09 07:39:20 -0500
    • Engine revision f6344b75dc
    • Dart version 3.4.0
    • DevTools version 2.34.3

[√] Windows Version (Installed version of Windows is version 10 or higher)

[√] Android toolchain - develop for Android devices (Android SDK version 33.0.2)     
    • Android SDK at C:\Users\xxx\AppData\Local\Android\sdk
    • Platform android-34, build-tools 33.0.2
    • Java binary at: C:\Users\xxx\AppData\Local\Programs\Android Studio\jbr\bin\java
    • Java version OpenJDK Runtime Environment (build 17.0.7+0-b2043.56-10550314)    
    • All Android licenses accepted.

[√] Chrome - develop for the web
    • Chrome at C:\Program Files\Google\Chrome\Application\chrome.exe

[√] Visual Studio - develop Windows apps (Visual Studio Community 2022 17.9.5)       
    • Visual Studio at C:\Program Files\Microsoft Visual Studio\2022\Community
    • Visual Studio Community 2022 version 17.9.34723.18
    • Windows 10 SDK version 10.0.22000.0

[√] Android Studio (version 2022.1)
    • Android Studio at C:\Program Files\Android\Android Studio
    • 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 17.0.7+0-b2043.56-10550314)

[√] Android Studio (version 2023.1)
    • Android Studio at C:\Users\spe\AppData\Local\Programs\Android Studio
    • 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 17.0.7+0-b2043.56-10550314)

[√] VS Code, 64-bit edition (version 1.89.1)
    • VS Code at C:\Program Files\Microsoft VS Code
    • Flutter extension version 3.89.20240501

[√] Connected device (3 available)
    • SM T575 (mobile)  • R52W30B3CKY • android-arm64  • Android 13 (API 33)
    • Windows (desktop) • windows     • windows-x64    • Microsoft Windows [Version 10.0.19045.4291]
    • Chrome (web)      • chrome      • web-javascript • Google Chrome 124.0.6367.158

[√] Network resources
    • All expected network resources are available.

• No issues found!

[darshankawar]

@stan-at-work
Can you provide a runnable reproducible code sample that triggers this exception ?

[DPohorielov]

Same result (exception) is given in my case if I add showCloseIcon: true to SnackBar's constructor.

@stan-at-work Can you provide a runnable reproducible code sample that triggers this exception ?

@darshankawar Here it is. I don't use multiple Materials.
https://dartpad.dev/?id=f5694fd27654ed41dfae1f8df59a3a92

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(
      builder: (context, child) => Scaffold(
        body: Center(
          child: TextButton(
            onPressed: () => _showMessage(context),
            child: const Text('Press'),
          ),
        ),
      ),
    );
  }

  void _showMessage(BuildContext context) {
    ScaffoldMessenger.of(context).showSnackBar(
      const SnackBar(
        content: Text('message'),
        showCloseIcon: true,
      ),
    );
  }
}

Flutter 3.19.5: No errors

Flutter 3.22.1: Exceptions

══╡ EXCEPTION CAUGHT BY WIDGETS LIBRARY ╞═══════════════════════════════════════════════════════════
The following assertion was thrown building Tooltip("Close", dirty, dependencies: [_InheritedTheme,
_LocalizationsScope-[GlobalKey#d5a92]], state: TooltipState#58438):
No Overlay widget found.
Tooltip widgets require an Overlay widget ancestor within the closest LookupBoundary.
An overlay lets widgets float on top of other widget children.
To introduce an Overlay widget, you can either directly include one, or use a widget that contains
an Overlay itself, such as a Navigator, WidgetApp, MaterialApp, or CupertinoApp.
The specific widget that could not find a Overlay ancestor was:
  Tooltip
The ancestors of this widget were:
  ...
  Semantics
  Align
  Padding
  IconTheme
  Builder
  ...

Widget creation tracking is currently disabled. Enabling it enables improved error messages. It can
be enabled by passing `--track-widget-creation` to `flutter run` or `flutter test`.

When the exception was thrown, this was the stack

════════════════════════════════════════════════════════════════════════════════════════════════════
Another exception was thrown: A RenderFlex overflowed by 98784 pixels on the right.
Another exception was thrown: No Overlay widget found.

[darshankawar]

Thanks for the code. I was able to replicate this on latest stable and master version, whereas, the same code works properly in stable 3.19.6 showing the snackbar properly upon tapping on press button without throwing the error log.

Code sample used: #148314 (comment)

stable, master flutter doctor -v

[!] Flutter (Channel stable, 3.22.2, on macOS 12.2.1 21D62 darwin-x64, locale
    en-GB)
    • Flutter version 3.22.2 on channel stable at
      /Users/dhs/documents/fluttersdk/flutter
    ! Warning: `flutter` on your path resolves to
      /Users/dhs/Documents/Fluttersdk/flutter/bin/flutter, which is not inside
      your current Flutter SDK checkout at
      /Users/dhs/documents/fluttersdk/flutter. Consider adding
      /Users/dhs/documents/fluttersdk/flutter/bin to the front of your path.
    ! Warning: `dart` on your path resolves to
      /Users/dhs/Documents/Fluttersdk/flutter/bin/dart, which is not inside your
      current Flutter SDK checkout at /Users/dhs/documents/fluttersdk/flutter.
      Consider adding /Users/dhs/documents/fluttersdk/flutter/bin to the front
      of your path.
    • Upstream repository https://github.com/flutter/flutter.git
    • Framework revision 761747bfc5 (33 hours ago), 2024-06-05 22:15:13 +0200
    • Engine revision edd8546116
    • Dart version 3.4.3
    • DevTools version 2.34.3
    • If those were intentional, you can disregard the above warnings; however
      it is recommended to use "git" directly to perform update checks and
      upgrades.

[!] Xcode - develop for iOS and macOS (Xcode 12.3)
    • Xcode at /Applications/Xcode.app/Contents/Developer
    ! Flutter recommends a minimum Xcode version of 13.
      Download the latest version or update via the Mac App Store.
    • CocoaPods version 1.11.2

[✓] Chrome - develop for the web
    • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome

[✓] VS Code (version 1.62.0)
    • VS Code at /Applications/Visual Studio Code.app/Contents
    • Flutter extension version 3.21.0

[✓] Connected device (5 available)
    • SM G975F (mobile)       • RZ8M802WY0X • android-arm64   • Android 11 (API 30)
    • Darshan's iphone (mobile)  • 21150b119064aecc249dfcfe05e259197461ce23 •
      ios            • iOS 14.4.1 18D61
    • iPhone 12 Pro Max (mobile) • A5473606-0213-4FD8-BA16-553433949729     •
      ios            • com.apple.CoreSimulator.SimRuntime.iOS-14-3 (simulator)
    • macOS (desktop)            • macos                                    •
      darwin-x64     • Mac OS X 10.15.4 19E2269 darwin-x64
    • Chrome (web)               • chrome                                   •
      web-javascript • Google Chrome 98.0.4758.80

[✓] HTTP Host Availability
    • All required HTTP hosts are available

! Doctor found issues in 1 category.

[!] Flutter (Channel master, 3.23.0-13.0.pre.100, on macOS 12.2.1 21D62
    darwin-x64, locale en-GB)
    • Flutter version 3.23.0-13.0.pre.100 on channel master at
      /Users/dhs/documents/fluttersdk/flutter
    ! Warning: `flutter` on your path resolves to
      /Users/dhs/Documents/Fluttersdk/flutter/bin/flutter, which is not inside
      your current Flutter SDK checkout at
      /Users/dhs/documents/fluttersdk/flutter. Consider adding
      /Users/dhs/documents/fluttersdk/flutter/bin to the front of your path.
    ! Warning: `dart` on your path resolves to
      /Users/dhs/Documents/Fluttersdk/flutter/bin/dart, which is not inside your
      current Flutter SDK checkout at /Users/dhs/documents/fluttersdk/flutter.
      Consider adding /Users/dhs/documents/fluttersdk/flutter/bin to the front
      of your path.
    • Upstream repository https://github.com/flutter/flutter.git
    • Framework revision 63daac2a51 (4 hours ago), 2024-06-04 21:16:19 -0400
    • Engine revision 11a32d43e3
    • Dart version 3.5.0 (build 3.5.0-222.0.dev)
    • DevTools version 2.36.0
    • If those were intentional, you can disregard the above warnings; however
      it is recommended to use "git" directly to perform update checks and
      upgrades.

[!] Android toolchain - develop for Android devices (Android SDK version 30.0.3)
    • Android SDK at /Users/dhs/Library/Android/sdk
    ✗ cmdline-tools component is missing
      Run `path/to/sdkmanager --install "cmdline-tools;latest"`
      See https://developer.android.com/studio/command-line for more details.
    ✗ Android license status unknown.
      Run `flutter doctor --android-licenses` to accept the SDK licenses.
      See https://flutter.dev/docs/get-started/install/macos#android-setup for
      more details.

[✓] Xcode - develop for iOS and macOS (Xcode 13.2.1)
    • Xcode at /Applications/Xcode.app/Contents/Developer
    • Build 13C100
    • CocoaPods version 1.11.2

[✓] Chrome - develop for the web
    • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome

[✓] IntelliJ IDEA Ultimate Edition (version 2021.3.2)
    • IntelliJ at /Applications/IntelliJ IDEA.app
    • Flutter plugin version 65.1.4
    • Dart plugin version 213.7228

[✓] VS Code (version 1.62.0)
    • VS Code at /Applications/Visual Studio Code.app/Contents
    • Flutter extension version 3.29.0

[✓] Connected device (3 available)
    • Darshan's iphone (mobile) • 21150b119064aecc249dfcfe05e259197461ce23 • ios
      • iOS 15.3.1 19D52
    • macOS (desktop)           • macos                                    •
      darwin-x64     • macOS 12.2.1 21D62 darwin-x64
    • Chrome (web)              • chrome                                   •
      web-javascript • Google Chrome 109.0.5414.119

[✓] Network resources
    • All expected network resources are available.

! Doctor found issues in 1 category.
      
[!] Xcode - develop for iOS and macOS (Xcode 12.3)
    • Xcode at /Applications/Xcode.app/Contents/Developer
    ! Flutter recommends a minimum Xcode version of 13.
      Download the latest version or update via the Mac App Store.
    • CocoaPods version 1.11.2

[✓] Chrome - develop for the web
    • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome

[✓] VS Code (version 1.62.0)
    • VS Code at /Applications/Visual Studio Code.app/Contents
    • Flutter extension version 3.21.0

[✓] Connected device (5 available)
    • SM G975F (mobile)       • RZ8M802WY0X • android-arm64   • Android 11 (API 30)
    • Darshan's iphone (mobile)  • 21150b119064aecc249dfcfe05e259197461ce23 •
      ios            • iOS 14.4.1 18D61
    • iPhone 12 Pro Max (mobile) • A5473606-0213-4FD8-BA16-553433949729     •
      ios            • com.apple.CoreSimulator.SimRuntime.iOS-14-3 (simulator)
    • macOS (desktop)            • macos                                    •
      darwin-x64     • Mac OS X 10.15.4 19E2269 darwin-x64
    • Chrome (web)               • chrome                                   •
      web-javascript • Google Chrome 98.0.4758.80

[✓] HTTP Host Availability
    • All required HTTP hosts are available

! Doctor found issues in 1 category.

[hayatshin]

I face same issue, after I update flutter version, I have this issue.
And and I delete 'showCloseIcon: true', this error disappears, but I need to use 'showCloseIcon'.

[goderbauer]

This is working as intended because you're not including an Overlay widget in the tree and the close button of the snackbar (showCloseIcon: true) requires an Overlay to be present so it can show itself if necessary.

By default, MaterialApp introduces a Navigator, which includes an Overlay. However, MaterialApp.builder is a hook to wrap the Navigator (provided as child to MaterialApp.builder) with other widgets and therefore the context passed to MaterialApp.builder does not include an Overlay. If you want to use this context for anything that needs an Overlay (like showing a snackbar with a close button that has a tooltip) you'll have to introduce the Overlay yourself (or use a context that is a descendant of the Navigator introduced by MaterialApp).

This didn't crash in 3.19.5 because the tooltip for the close button of the snack bar was only introduced in #143934 as an accessibility fix. Not having the tooltip was a bug that made the snackbar less accessible.

[Sten435]

This is working as intended because you're not including an Overlay widget in the tree and the close button of the snackbar (showCloseIcon: true) requires an Overlay to be present so it can show itself if necessary.

By default, MaterialApp introduces a Navigator, which includes an Overlay. However, MaterialApp.builder is a hook to wrap the Navigator (provided as child to MaterialApp.builder) with other widgets and therefore the context passed to MaterialApp.builder does not include an Overlay. If you want to use this context for anything that needs an Overlay (like showing a snackbar with a close button that has a tooltip) you'll have to introduce the Overlay yourself (or use a context that is a descendant of the Navigator introduced by MaterialApp).

This didn't crash in 3.19.5 because the tooltip for the close button of the snack bar was only introduced in #143934 as an accessibility fix. Not having the tooltip was a bug that made the snackbar less accessible.

This should be documented in the comments, now its hard to see why this is not a bug.

[goderbauer]

This is documented on the MaterialApp.builder property (https://main-api.flutter.dev/flutter/material/MaterialApp/builder.html):

Unless a Navigator is provided, either implicitly from builder being null, or by a builder including its child argument, or by a builder explicitly providing a Navigator of its own, or by the routerDelegate building one, widgets and APIs such as Hero, Navigator.push and Navigator.pop, will not function.

Material specific features such as showDialog and showMenu, and widgets such as Tooltip, PopupMenuButton, also require a Navigator to properly function.

What additional information would have made this clearer?

[github-actions]

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 -v and a minimal reproduction of the issue.