Skip to content

Improve documentation of EditableText/TextField callbacks#98414

Merged
fluttergithubbot merged 2 commits intoflutter:masterfrom
NevercodeHQ:update_editable_text_doc
Mar 4, 2022
Merged

Improve documentation of EditableText/TextField callbacks#98414
fluttergithubbot merged 2 commits intoflutter:masterfrom
NevercodeHQ:update_editable_text_doc

Conversation

@TahaTesser
Copy link
Contributor

@TahaTesser TahaTesser commented Feb 14, 2022 •
edited
Loading

fixes #27581

1. TextField doesn't mention order of onSubmitted vs onEditingComplete vs onChanged.

Solution:
Made Lifecycle from EditableText as a template so it can be reused in TextField

2. The documentation for each of these events doesn't mention the others.

Solution:

  • Update onSubmitted to indicate when it will be called relative to other callbacks
  • Update onChange to indicate when it will be called relative to other callbacks

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I signed the CLA.
  • I listed at least one issue that this PR fixes in the description above.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@flutter-dashboard flutter-dashboard bot added a: text input Entering text in a text field or keyboard related problems f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. labels Feb 14, 2022
@TahaTesser TahaTesser changed the title Mention the order in onSubmitted vs onEditingComplete vs onChanged ha… Improve documentation of EditableText/TextField callbacks Feb 14, 2022
@HansMuller HansMuller requested a review from cbracken February 25, 2022 22:53
cbracken
cbracken approved these changes Mar 4, 2022
View reviewed changes
packages/flutter/lib/src/widgets/editable_text.dart Outdated
Copy link
Member

@cbracken cbracken Mar 4, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe:

/// By default, [onSubmitted] is called after [onChanged] when the user 
/// has finalized editing; or, if the default behavior has been overridden,
/// after [onEditingComplete]. See [onEditingComplete] for details.

Also minor nit, behaviour -> behavior. I'm guilty of adding hundreds of non-US spellings to our codebase myself, and occasionally do passes over the code to fix all the ones I missed 😉

Copy link
Contributor Author

@TahaTesser TahaTesser Mar 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohh thanks so much, I will keep it in mind for future doc PRs)

@TahaTesser TahaTesser force-pushed the update_editable_text_doc branch from b7bb6f8 to 87d16ca Compare March 4, 2022 18:47
@fluttergithubbot fluttergithubbot merged commit e047fe7 into flutter:master Mar 4, 2022
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 4, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 4, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
54a8784 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 4, 2022
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Mar 4, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
9f58cff 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 4, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 4, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
0b7bcf7 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 4, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 4, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
9c7ec55 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 4, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 4, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
3d771b7 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 4, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 4, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
83f403a 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 4, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 4, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
3ce4b3a 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 4, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 4, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
a1e58ea 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 5, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 5, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
ee19e6a 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 5, 2022
Closed
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
515d037 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
fd26415 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
84f635e 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
b8054c1 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
f2a1423 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
38c2acb 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
43d03b6 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
1695029 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
53ee780 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
fd2a225 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 7, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
debdc7a 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 8, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 8, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
bba9d97 
…flutter/flutter#98414)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 8, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 8, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
0f9b179 
…flutter/flutter#98414)
This was referenced Mar 8, 2022
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cbracken cbracken cbracken approved these changes

Assignees

No one assigned

Labels

a: text input Entering text in a text field or keyboard related problems f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

TextField documentation should say the order in which onSubmitted vs onEditingComplete vs onChanged happens

3 participants

@TahaTesser @cbracken @fluttergithubbot