Skip to content
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.

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

Chore: Move spellchecker service to extensions #2120

Merged

Conversation

CatHood0
Copy link
Collaborator

Description

Since SimpleSpellCheckerService is a custom implementation that is not needed by default, was moved to Flutter Quill Extensions and can be used such as SuperClipboard implementation:

FlutterQuillExtensions.useSpellCheckerService('<your_language>');

And was fixed some issue with some missing characters while typing (this is for languages such as portuguese, deutsch, italian, etc)

  • New feature: Adds new functionality without breaking existing features.
  • 🛠️ Bug fix: Resolves an issue without altering current behavior.
  • 🧹 Code refactor: Code restructuring that does not affect behavior.
  • Breaking change: Alters existing functionality and requires updates.
  • 🧪 Tests: Adds new tests or modifies existing tests.
  • 📝 Documentation: Updates or additions to documentation.
  • 🗑️ Chore: Routine tasks, or maintenance.
  • Build configuration change: Changes to build or deploy processes.

Suggestions

Please, after update the version of the main repo, also update it into flutter_quill_extensions to avoid conflicts since the new version change the names of the classes and methods.

@CatHood0 CatHood0 marked this pull request as draft August 18, 2024 23:07
@CatHood0 CatHood0 marked this pull request as ready for review August 18, 2024 23:20
@CatHood0 CatHood0 requested review from Jon-Salmon and EchoEllet and removed request for Jon-Salmon August 18, 2024 23:42
@singerdmx singerdmx merged commit da4f0ef into singerdmx:master Aug 19, 2024
2 checks passed
@CatHood0 CatHood0 deleted the move_spellchecker_service_to_extensions branch August 19, 2024 00:20

static void setInstance(SpellcheckerService service) {
static void setNewCheckerService(SpellCheckerService service) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

We might want to enable this service in the example as well.

Copy link
Collaborator Author

@CatHood0 CatHood0 Aug 19, 2024

Choose a reason for hiding this comment

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

I'll add it later. I'm still doing the documentation about the Feature to the README

_instance.setNewLanguageState(language: language);
}

static void turnOffService() {
Copy link
Collaborator

Choose a reason for hiding this comment

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

This can be a breaking change, though it hasn't been used yet.

I'm interested in knowing the reason for the naming changes if available.

Same for the static method setInstance

Copy link
Collaborator Author

@CatHood0 CatHood0 Aug 19, 2024

Choose a reason for hiding this comment

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

I changed the names so that they made more sense in the context of what the service is in charge of doing. However, as it is still an experimental feature for now, it is quite subject to change.

For example, with documents that have many spelling errors (if the Spell checker detects them) then the load could be greater than expected.

For this I am still looking for a solution to how Word or LibreOffice do it, which first show all the text, and then little by little let the UI update the specific parts that are wrong, which avoids that drop in performance of the app

Or that, for example, suggestions for words that are misspelled have not yet been implemented.

It is likely that I will soon change the names of the instances to be less confusing, but it would be in the update for Flutter Quill 11

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants