Spellcheck for EditableText on iOS/Android

[LongCatIsLooong]

Related Issue: #12920 autocorrection
Related UIKit documentation: https://developer.apple.com/documentation/uikit/uitextinputtraits/1624461-spellcheckingtype

• Red underline to mark misspelled words
• Spellcheck on typing & double-tap selection & caret moving, etc.
• When a word is marked misspelled, show correction candidate list bubble on:
  • Single tap
  • Moving the caret to the end of the word by pressing backspace.

[HansMuller]

Android also supports a spell checking service: https://developer.android.com/guide/topics/text/spell-checker-framework

[ajviera]

Any news on this issue? It would be ideal to be able to have this so that the applications are more similar to the native ones.

[dnfield]

Would anything prevent this from being a plugin?

[LongCatIsLooong]

~If we want to use the stock spell checker on iOS (probably not going to be easy) we would have to make changes to the ios text plugin I think, as there doesn't seem to be a standalone spell checking api on iOS, it's most likely a feature we get from implementing UITextInput. ~

Edit: there is UITextChecker

[dnfield]

Ahh, I see.

Yeah, this sounds like something that belongs in the TextInputPlugin in the engine.

It actually doesn't sound like it'd be too terrible to implement - on iOS for example we should be able to just use an attributed string instead of a plain NSString, and then send annotations back to the framework as spelling corrections come in. I realize there's some async issues to tangle with there though :)

[SeanBlagsvedt]

This is a fundamental issue to any user of a flutter app. Literally my users are telling me they don't want to use my flutter-based messaging app dara.network because they end up sending out misspellings to those they are attempting to impress. It's literally hurting their social credibility. Please, please, please fix this.

[kevmoo]

Bumping to P3 – per @jenle-g – this feels like a big hole VS native platforms and the web.

[GauravCalidig]

+1

[blasten]

@LongCatIsLooong are you working or planning to work on this issue?

[namvietcetera]

Any updates for it?

[camsim99]

This is still in progress. Part of Android support was added in #109643 and iOS is on the way #110193. I'll update this issue when full support for both is completed.

[mohamedali170]

Hi @camsim99,
Any updates?

[camsim99]

@mohamedali170 Android and iOS both have partial implementation. Implementation of the red underline and the toolbar with suggestions for Android and iOS is expected around EOY. I'll update this issue when more pieces of the implementation land!

[mohamedali170]

Well, thanks very much for your efforts @camsim99 . I hope you can finish the remaining implementation in the near future.

[camsim99]

Just wanted to update here that I have merged the remaining implementation on Android into the master branch as of : #114460. Still working on somethings related to testing, though, as well as iOS!

[blopker]

Nice! Do you have an idea which version this might land in?

[camsim99]

Nice! Do you have an idea which version this might land in?

@blopker This should probably be in the next stable release if not the next beta release. Eventually, you can look for a version number on the merge commit of my latest PR, but it's not tagged now: e0742eb.

[jonbhanson]

It appears this feature has landed in Flutter 3.7. To use it, add this parameter to your EditableText or TextField:

spellCheckConfiguration: kIsWeb ? null : SpellCheckConfiguration()

(The spell check configuration currently seems to break on web)

[blopker]

Good progress! Sad news about web though. Hopefully we won't have to wait until another point release for it.

[camsim99]

It appears this feature has landed in Flutter 3.7. To use it, add this parameter to your EditableText or TextField:

spellCheckConfiguration: kIsWeb ? null : SpellCheckConfiguration()

(The spell check configuration currently seems to break on web)

@jonbhanson yes, spell check is partially implemented on both! Thank you for pointing out the crash on web. Filed an issue to follow up on better solutions for crashing in that case #119542

[leighajarett]

Closing this since it's now complete for iOS and Android as of 3.10

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.