WillPopScopeLoader class

Use this class instead of WillPopScope to control the ProgressLoader when the user tries dismiss the enclosing ModalRoute.

This can be tuned to prevent the user from popping the route, or to have the ProgressLoader dismiss itself when the user pops the route.

Note that, like Flutter's WillPopScope, this does not prevent navigation from code using Navigator.pop.

IMPORTANT: WillPopScope is a bit broken in Flutter on iOS, and will prevent users from navigating back even if onWillPop returns true. This widget relies on WillPopScope and suffers from the same issue. See here for more: https://github.com/flutter/flutter/issues/14203

Inheritance

Constructors

WillPopScopeLoader({Key? key, required Widget child, WillPopCallback? onWillPop, bool allowPopWhenLoading = false, bool dismissProgressLoaderWhenPopping = false})
const

Properties

allowPopWhenLoading bool
Set this to true to allow the route to be popped even when ProgressLoader is showing.
final
child Widget
The widget below this widget in the tree.
final
dismissProgressLoaderWhenPopping bool
If this and allowPopWhenLoading is true then popping the route will dismiss the ProgressLoader.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onWillPop WillPopCallback?
Called to veto attempts by the user to dismiss the enclosing ModalRoute.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited