Form fields onChange callback should be called on reset #134295

bleroux · 2023-09-08T12:49:52Z

Description

This PR fixes form fields in order to call the onChange callback when the form is reset.

This change is based on the work done in #123108.

I considered adding the onChange callback to the FormField superclass but it would break existing code because two of the three subclasses defines the onChange callback with ValueChanged<String>? type and the third one defines it with ValueChanged<String?>?.

Related Issue

Fixes #123009.

Tests

Adds 3 tests.

Renzo-Olivares · 2023-09-18T19:53:43Z

packages/flutter/lib/src/cupertino/text_form_field_row.dart

-        _effectiveController!.text = widget.initialValue!;
-      });
-    }
+    _cupertinoTextFormFieldRow.onChanged?.call(_effectiveController!.text);


Should we still call this if the value did not change?

Same for other FormFields.

I chose not to add such a check in order to be consistent with FormState.reset which (indirectly) call the Form.onChanged callback without checking if field values have changed.
I also checked that DropdownButton.onChanged is called when the same entry is selected.

Maybe we should consider this is another issue/PR? I don't know if this was done on purpose.

Renzo-Olivares · 2023-09-18T19:56:38Z

packages/flutter/lib/src/material/text_form_field.dart

@@ -272,6 +270,10 @@ class TextFormField extends FormField<String> {
  /// initialize its [TextEditingController.text] with [initialValue].
  final TextEditingController? controller;

+  /// Called when the user initiates a change to the TextField's


Can this be made a doc template and reused.

Probably, I upated the PR accordingly.

packages/flutter/test/material/text_form_field_test.dart

Renzo-Olivares

Thanks for the contribution @bleroux. Just had a few comments.

Renzo-Olivares · 2023-09-20T17:44:05Z

packages/flutter/lib/src/material/text_form_field.dart

@@ -272,6 +270,12 @@ class TextFormField extends FormField<String> {
  /// initialize its [TextEditingController.text] with [initialValue].
  final TextEditingController? controller;

+  /// {@template flutter.material.TestFormField.onChanged}


nit: TestFormField -> TextFormField. I think

Thanks for pointing this out!

Renzo-Olivares

LGTM w/ small nit. Thanks for fixing this @bleroux!

…utter/flutter#134295)

## Description This PR fixes form fields in order to call the `onChange` callback when the form is reset. This change is based on the work done in flutter#123108. I considered adding the `onChange` callback to the `FormField` superclass but it would break existing code because two of the three subclasses defines the `onChange` callback with `ValueChanged<String>?` type and the third one defines it with `ValueChanged<String?>?`. ## Related Issue Fixes flutter#123009. ## Tests Adds 3 tests.

…utter/flutter#134295)

bleroux mentioned this pull request Sep 8, 2023

Fix FormField implementation components TextFormField, DropdownButtonFormField, CupertinoTextFormFieldRow. The problem that their onChange() method cannot be executed when the parent Form component calls the reset() method #123108

Closed

bleroux force-pushed the formfield_onchange_should_be_called_after_reset branch 5 times, most recently from 90eea5c to ba88062 Compare September 12, 2023 12:38

bleroux requested a review from Renzo-Olivares September 12, 2023 20:15

bleroux force-pushed the formfield_onchange_should_be_called_after_reset branch from ba88062 to 2af641f Compare September 15, 2023 07:10

Renzo-Olivares reviewed Sep 18, 2023

View reviewed changes

packages/flutter/test/material/text_form_field_test.dart Outdated Show resolved Hide resolved

Renzo-Olivares reviewed Sep 18, 2023

View reviewed changes

packages/flutter/test/material/text_form_field_test.dart Outdated Show resolved Hide resolved

Renzo-Olivares reviewed Sep 18, 2023

View reviewed changes

bleroux force-pushed the formfield_onchange_should_be_called_after_reset branch from 2af641f to 28efbee Compare September 20, 2023 06:31

bleroux requested a review from Renzo-Olivares September 20, 2023 09:19

bleroux force-pushed the formfield_onchange_should_be_called_after_reset branch from 28efbee to fc3af56 Compare September 20, 2023 09:19

Renzo-Olivares reviewed Sep 20, 2023

View reviewed changes

Renzo-Olivares approved these changes Sep 20, 2023

View reviewed changes

bleroux force-pushed the formfield_onchange_should_be_called_after_reset branch 2 times, most recently from 914a2fa to 57c90cc Compare September 20, 2023 18:50

bleroux and others added 2 commits September 20, 2023 22:14

Form fields onChange callback should be called on reset

ea1d355

Address review comments

0ec68a8

bleroux force-pushed the formfield_onchange_should_be_called_after_reset branch from 57c90cc to 0ec68a8 Compare September 20, 2023 20:15

bleroux added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 21, 2023

auto-submit bot merged commit 07cc3f7 into flutter:master Sep 21, 2023
67 checks passed

bleroux deleted the formfield_onchange_should_be_called_after_reset branch September 21, 2023 05:54

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 22, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

21c8bdd

…utter/flutter#134295)

engine-flutter-autoroll mentioned this pull request Sep 22, 2023

Roll Flutter from 893650416352 to 06780cb1d069 (87 revisions) flutter/packages#4979

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 22, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

750a7c2

…utter/flutter#134295)

engine-flutter-autoroll mentioned this pull request Sep 22, 2023

Roll Flutter from 893650416352 to 74c6693170e1 (88 revisions) flutter/packages#4980

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 22, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

eb9eabc

…utter/flutter#134295)

engine-flutter-autoroll mentioned this pull request Sep 22, 2023

Roll Flutter from 893650416352 to dbe0ccd8853d (89 revisions) flutter/packages#4981

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 22, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

5f4cafd

…utter/flutter#134295)

engine-flutter-autoroll mentioned this pull request Sep 22, 2023

Roll Flutter from 893650416352 to 76a938bfa6d1 (90 revisions) flutter/packages#4983

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 22, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

dc40b5d

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 25, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

d1d1cb5

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 26, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

727fdb3

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 26, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

7412c40

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 26, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

9c7e0c5

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 26, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

c7ee0dc

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 26, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

e8ba312

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 27, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

d02a8cf

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 27, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

90e4869

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 27, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

4f17e52

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 27, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

4a97b25

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 27, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

b1f822a

…utter/flutter#134295)

HansMuller mentioned this pull request Sep 28, 2023

Flutter Framework Team: Notable Commits #121415

Open

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 28, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

5182fc4

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 28, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

8ae668c

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 28, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

8fb67b2

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 28, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

a30d1cf

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 28, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

8d4b5dd

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 28, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

99e8360

…utter/flutter#134295)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 15, 2023

07cc3f7a6 Form fields onChange callback should be called on reset (fl…

ec4fac2

…utter/flutter#134295)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Form fields onChange callback should be called on reset #134295

Form fields onChange callback should be called on reset #134295

bleroux commented Sep 8, 2023 •

edited

Renzo-Olivares Sep 18, 2023

Renzo-Olivares Sep 18, 2023

bleroux Sep 20, 2023

Renzo-Olivares Sep 18, 2023

bleroux Sep 20, 2023

Renzo-Olivares left a comment

Renzo-Olivares Sep 20, 2023

bleroux Sep 20, 2023

Renzo-Olivares left a comment

Form fields onChange callback should be called on reset #134295

Form fields onChange callback should be called on reset #134295

Conversation

bleroux commented Sep 8, 2023 • edited

Description

Related Issue

Tests

Renzo-Olivares Sep 18, 2023

Choose a reason for hiding this comment

Renzo-Olivares Sep 18, 2023

Choose a reason for hiding this comment

bleroux Sep 20, 2023

Choose a reason for hiding this comment

Renzo-Olivares Sep 18, 2023

Choose a reason for hiding this comment

bleroux Sep 20, 2023

Choose a reason for hiding this comment

Renzo-Olivares left a comment

Choose a reason for hiding this comment

Renzo-Olivares Sep 20, 2023

Choose a reason for hiding this comment

bleroux Sep 20, 2023

Choose a reason for hiding this comment

Renzo-Olivares left a comment

Choose a reason for hiding this comment

bleroux commented Sep 8, 2023 •

edited