Skip to content

Latest commit

 

History

History
79 lines (59 loc) · 3.9 KB

spell_checker.md

File metadata and controls

79 lines (59 loc) · 3.9 KB
Raw

📝 Spelling checker

A spell checker is a software tool or feature integrated into various text processing applications that automatically identifies and corrects spelling errors in a written document. It works by comparing the words in the text against a built-in dictionary. If a word isn't found in the dictionary or doesn't match any known word patterns, the spell checker highlights it as a potential error.

While spell-checking is not a feature that's implemented into the project, it can be used using external dependencies.

It's implemented using the package simple_spell_checker in the Example.

Note

simple_spell_checker is a client-side dependency that works without an internet connection, so, it could weigh more than expected due to each of the dictionaries. As mentioned below, it supports a very wide variety of languages which can have a file of up to 300.000 words (this being just one language).

Benefits of a spell checker include:

  • Improved Accuracy: It helps writers avoid common spelling mistakes, ensuring that the text is free of errors.
  • Time-Saving: Automatically detecting errors reduces the time needed for manual proofreading.
  • Enhanced Professionalism: Correctly spelled words contribute to the overall professionalism of documents, which is crucial in academic, business, and formal writing.
  • Multilingual Support: Many spell checkers support multiple languages, making it easier for users to write accurately in different languages.

Important

The spell checker usually does not work as expected in most cases. For now it is a purely experimental feature that may have code that will be modified in future versions.

The translations supported so far are:

  • German - de, de-ch
  • English - en, en-gb
  • Spanish - es
  • Catalan - ca
  • Arabic - ar
  • Danish - da
  • French - fr
  • Bulgarian - bg
  • Dutch - nl
  • Korean - ko
  • Estonian - et
  • Hebrew - he
  • Slovak - sk
  • Italian - it
  • Norwegian - no
  • Portuguese - pt
  • Swedish - sv
  • Russian - ru

Note: If you have knowledge about any of these available languages or the unsupported ones, you can make a pull request to add support or add words that are not currently in simple_spell_checker.

In order to activate this functionality you can use the following code:

// you can use the language of your preference or directly select the language of the operating system
final language = 'en'; // or Localizations.localeOf(context).languageCode
SpellChecker.useSpellCheckerService(language);

Note

The class SpellChecker is not available as part of the project API. Instead, you will have to implement it manually. Take a look at the example Spell Checker class.

When you no longer need to have the Spell checker activated you can simply use dispose() of the SpellCheckerServiceProvider class:

// dispose all service and it cannot be used after this
SpellCheckerServiceProvider.dispose();

If what we want is to close the StreamControllers without deleting the values that are already stored in it, we can set onlyPartial to true.

// it can be still used by the editor
SpellCheckerServiceProvider.dispose(onlyPartial: true);

One use of this would be having the opportunity to activate and deactivate the service when we want, we can see this in the example that we have in this package, in which you can see that on each screen, we have a button that dynamically activates and deactivates the service. To do this is pretty simple:

 SpellCheckerServiceProvider.toggleState();
 // use isServiceActive to get the state of the service
 SpellCheckerServiceProvider.isServiceActive();
 setState(() {});

Open this page for more information.