Suggest predicate-based formatter in [FilteringTextInputFormatter] docs for whole string matching #107848
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
string predicates in its documentation. - Fixes flutter#78100
goderbauer
approved these changes
Jul 26, 2022
| /// preserve the existing [TextEditingValue.selection] to values it would now | ||
| /// fall at with the removed characters. | ||
| /// A [FilteringTextInputFormatter] also tries to preserve the existing | ||
| /// [TextEditingValue.selection] and [TextEditingValue.composing], and adjusts |
There was a problem hiding this comment.
nit: maybe add a "region" after "[TextEditingValue.composing]" to make this read better?
| /// them accordingly if text within either of these ranges is replaced. | ||
| /// | ||
| /// This formatter is typically used to match potentially recurring [Pattern]s | ||
| /// in the new [TextEditingValue], and it never completely rejects the new |
There was a problem hiding this comment.
maybe break this sentence up a little. It's super long with the two "and"s.
|
@goderbauer rephrased some of the new docs could you take a look again? |
goderbauer
approved these changes
Jul 27, 2022
| /// [TextEditingValue] and falls back to the current [TextEditingValue] when the | ||
| /// given [filterPattern] fails to match. Consider using a different | ||
| /// [TextInputFormatter] such as: | ||
| /// `TextInputFormatter.withFunction((oldValue, newValue) => regExp.hasMatch(newValue.text) ? newValue : oldValue)`. |
There was a problem hiding this comment.
could you wrap this in a ```dart section to get nicer code formatting in docs?
justinmc
approved these changes
Jul 27, 2022
| /// fall at with the removed characters. | ||
| /// A [FilteringTextInputFormatter] also tries to preserve the existing | ||
| /// [TextEditingValue.selection] and the [TextEditingValue.composing] region, | ||
| /// adjusting them accordingly if text within either of these ranges is replaced. |
There was a problem hiding this comment.
Nit: Is it also possible that that text before these ranges is replaced and they need to be updated? Not sure but just being pedantic.
| /// for accepting/rejecting new input based on a predicate on the full string. | ||
| /// As an example, [FilteringTextInputFormatter] typically shouldn't be used | ||
| /// with [RegExp]s that contain positional matchers (`^` or `$`) since these | ||
| /// patterns are usually meant for matching the whole string. |
There was a problem hiding this comment.
This is much more clear to me and I feel like I know what to do in both situations thanks to the examples 👍
|
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/plugins
that referenced
this pull request
Jul 28, 2022
…tter] docs for whole string matching (flutter/flutter#107848)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Jul 28, 2022
…tter] docs for whole string matching (flutter/flutter#107848)
camsim99
pushed a commit
to camsim99/flutter
that referenced
this pull request
Aug 10, 2022
…cs for whole string matching (flutter#107848)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explains when not to use a
FilteringTextInputFormatter.Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.