Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improve documentation of EditableText/TextField callbacks #98414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Mar 4, 2022
Merged

Improve documentation of EditableText/TextField callbacks #98414

merged 2 commits into from
Mar 4, 2022

Conversation

TahaTesser
Copy link
Member

@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
///
/// When the user has finalized editing, by default [onSubmitted] is called after
/// [onChanged] or after [onEditingComplete] when the default behaviour is overridden.
/// See [onEditingComplete] for details.
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
Member Author

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 added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
f35f340 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
e271c27 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
5a329dd 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
8cdd417 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
0e77e31 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
1a2fb28 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
5d9fe24 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 11, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
721d0df 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 12, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
acaeef1 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
efc961a 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
74f6a3a 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
d162ffd 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
720366c 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
6f9ccc2 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
b312bbe 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
3a89ad7 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
c9582ad 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
bd8a0cb 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
8a8d909 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
ad911ac 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
30294a3 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
8dc7cec 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
bae7a0f 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 14, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
3176af8 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 15, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
214a18e 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 15, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
e2b1db9 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 15, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
07830cb 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 15, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
e3a2158 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 15, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
2ea4fa6 
…flutter/flutter#98414)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 15, 2022
@engine-flutter-autoroll
e047fe7 Improve documentation of EditableText/TextField callbacks (…
6760325 
…flutter/flutter#98414)
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