@@ -9,17 +9,38 @@ class FormBuilder extends StatefulWidget {
99 /// will rebuild.
1010final VoidCallback ? onChanged;
1111
12- /// Enables the form to veto attempts by the user to dismiss the [ModalRoute]
13- /// that contains the form.
12+ /// {@macro flutter.widgets.navigator.onPopInvoked}
1413 ///
15- /// If the callback returns a Future that resolves to false, the form's route
16- /// will not be popped.
14+ /// {@tool dartpad}
15+ /// This sample demonstrates how to use this parameter to show a confirmation
16+ /// dialog when a navigation pop would cause form data to be lost.
17+ ///
18+ /// ** See code in examples/api/lib/widgets/form/form.1.dart **
19+ /// {@end-tool}
1720 ///
1821 /// See also:
1922 ///
20- /// * [WillPopScope] , another widget that provides a way to intercept the
23+ /// * [canPop] , which also comes from [PopScope] and is often used in
24+ /// conjunction with this parameter.
25+ /// * [PopScope.onPopInvoked] , which is what [Form] delegates to internally.ther widget that provides a way to intercept the
2126 /// back button.
22- final WillPopCallback ? onWillPop;
27+ final void Function (bool )? onPopInvoked;
28+
29+ /// {@macro flutter.widgets.PopScope.canPop}
30+ ///
31+ /// {@tool dartpad}
32+ /// This sample demonstrates how to use this parameter to show a confirmation
33+ /// dialog when a navigation pop would cause form data to be lost.
34+ ///
35+ /// ** See code in examples/api/lib/widgets/form/form.1.dart **
36+ /// {@end-tool}
37+ ///
38+ /// See also:
39+ ///
40+ /// * [onPopInvoked] , which also comes from [PopScope] and is often used in
41+ /// conjunction with this parameter.
42+ /// * [PopScope.canPop] , which is what [Form] delegates to internally.
43+ final bool ? canPop;
2344
2445 /// The widget below this widget in the tree.
2546 ///
@@ -81,11 +102,12 @@ class FormBuilder extends StatefulWidget {
81102 required this .child,
82103 this .onChanged,
83104 this .autovalidateMode,
84- this .onWillPop ,
105+ this .onPopInvoked ,
85106 this .initialValue = const < String , dynamic > {},
86107 this .skipDisabled = false ,
87108 this .enabled = true ,
88109 this .clearValueOnUnregister = false ,
110+ this .canPop,
89111 });
90112
91113 static FormBuilderState ? of (BuildContext context) =>
@@ -315,7 +337,8 @@ class FormBuilderState extends State<FormBuilder> {
315337 return Form (
316338 key: _formKey,
317339 autovalidateMode: widget.autovalidateMode,
318- onWillPop: widget.onWillPop,
340+ onPopInvoked: widget.onPopInvoked,
341+ canPop: widget.canPop,
319342 // `onChanged` is called during setInternalFieldValue else will be called early
320343 child: _FormBuilderScope (
321344 formState: this ,
0 commit comments