WillPopScope is deprecated: replacing it with PopScope
WillPopScope is deprecatedShort answer
WillPopScope decided at pop time, PopScope decides ahead of time. Set canPop to true or false, and use onPopInvokedWithResult to react after a pop attempt. For a confirm-before-leaving dialog, use canPop false and call Navigator.pop yourself once the user agrees.
Fix it fast
1Find out which cause you have
Let the analyzer list every place that still uses the old API, then fix them one by one with the matching cause below.
flutter analyze | grep -i -E "willpop|onPopInvoked"2Match what you see, then jump to its fix
- 1
onWillPop just returns a bool that is already knownWillPopScope with a fixed conditionFix - 2
onWillPop awaits a dialog and returns its answerWillPopScope used to show a confirm dialogFix - 3
onPopInvoked is flagged as deprecatedThe deprecated onPopInvoked callbackFix - 4
The warning points at a Form, or at a WillPopScope around an inner NavigatorForm.onWillPop and nested navigatorsFix
- 1
What does the error look like?
WillPopScope is deprecatedonPopInvoked is deprecatedonWillPop is deprecated
Cause 1 of 4
WillPopScope with a fixed condition
1Check
If the callback only returns a flag, nothing async is needed.
grep -rn "WillPopScope" lib/2Fix
Pass the flag as canPop. The check now happens before the pop, not during it.
PopScope(
canPop: _myCondition,
child: const MyPage(),
)3Verify
Run the analyzer again. The warning for that widget is gone.
flutter analyzeConfirmed by docs.flutter.dev
Cause 2 of 4
WillPopScope used to show a confirm dialog
1Check
PopScope cannot wait for an answer, because it must know canPop up front. onPopInvokedWithResult runs after the pop attempt was handled.
grep -rn "showDialog" lib/ | head2Fix
Set canPop to false. In the callback, return when didPop is true, otherwise ask the user and call pop yourself.
PopScope(
canPop: false,
onPopInvokedWithResult: (bool didPop, Object? result) async {
if (didPop) return;
final NavigatorState navigator = Navigator.of(context);
final bool? shouldPop = await _showBackDialog();
if (shouldPop ?? false) {
navigator.pop();
}
},
child: child,
)3Verify
Press back: the dialog shows. Confirm, and the page closes.
flutter runConfirmed by docs.flutter.dev
Cause 3 of 4
The deprecated onPopInvoked callback
1Check
An earlier PopScope callback was replaced by one that also carries the pop result.
grep -rn "onPopInvoked:" lib/2Fix
Rename the argument to onPopInvokedWithResult and take the extra result parameter.
PopScope(
canPop: true,
onPopInvokedWithResult: (bool didPop, Object? result) {
_saveDraft();
},
child: child,
)3Verify
Analyze again.
flutter analyzeConfirmed by api.flutter.dev
Cause 4 of 4
Form.onWillPop and nested navigators
1Check
These two places have their own replacements.
grep -rn "onWillPop" lib/2Fix
Form takes canPop and onPopInvokedWithResult, used like PopScope. For a nested Navigator, wrap it in NavigatorPopHandler.
NavigatorPopHandler(
onPop: () => _nestedNavigatorKey.currentState!.pop(),
child: Navigator(
key: _nestedNavigatorKey,
onGenerateRoute: _onGenerateRoute,
),
)3Verify
Press back inside the nested flow. It pops the inner route first.
flutter runConfirmed by docs.flutter.dev
How do I stop it coming back?
- Run flutter analyze in CI so deprecations show up when you upgrade Flutter.
- Decide canPop from state (for example unsaved changes) instead of asking at pop time.
- Read the breaking-changes page before each Flutter upgrade.
Sources
How was this page made?
I drafted this page with AI assistance from the official documents listed under Sources. Every cause above names the document that confirms it. I have not reproduced this fix on a machine of my own yet, so read it as documented guidance, not a test report. Found a mistake? Tell me.
Which stack is behind this page?
Projects of mine built on the same technologies:
- TaxiDexMy own multi-tenant taxi dispatch SaaS: API, dispatcher portal, driver and passenger apps, and the servers underneath.
- Qist BazaarA buy-now-pay-later marketplace built from a blank repo, now past 100K downloads on Google Play.
- SessionBirdAn omnichannel engagement suite in Flutter: campaigns, chatbot, tickets, analytics and live calling.
Related fixes
Mobile apps
AudioCache has no play method after updating audioplayers
The method 'play' isn't defined for the type 'AudioCache'.
Since audioplayers 1.0, AudioCache only turns asset files into local files and caches them.
2 causes, each with a fixMobile apps
Flutter Bloc throws that emit was called after the event handler completed
emit was called after an event handler completed normally.
Each on<Event> handler gets its own Emitter, and it stops working the moment the handler's returned Future completes.
2 causes, each with a fixMobile apps
analysis_options.yaml: the URI it includes can't be found
include_file_not_found
The analyzer reports include_file_not_found when the file named after include: in analysis_options.yaml does not resolve.
2 causes, each with a fixMobile apps
Dart error: the body might complete normally and return null for a non-nullable type
body_might_complete_normally
Dart found a path through your function or callback that reaches the closing brace without a return.
3 causes, each with a fixMobile apps
Dart throws ConcurrentModificationError while looping over a list
ConcurrentModificationError
Dart throws this when a collection changes size while something iterates it.
2 causes, each with a fixMobile apps
Dart cannot turn a compact timestamp like 20201101153000 into a DateTime
FormatException: Invalid date format
DateTime.parse accepts a subset of ISO 8601, and a time part must be introduced by T or a space.
2 causes, each with a fix