From 82308daa0ec2913c541124d8f97beed83fd7abdb Mon Sep 17 00:00:00 2001 From: Cat <114286961+CatHood0@users.noreply.github.com> Date: Wed, 21 Aug 2024 11:46:11 -0400 Subject: [PATCH] Chore: improve Spell checker API to the example (#2133) --- README.md | 19 +++++++----------- example/lib/screens/quill/quill_screen.dart | 20 +++++++++---------- .../simple_spell_checker_service.dart | 6 ++++++ flutter_quill_extensions/pubspec.yaml | 2 +- .../default_spellchecker_service.dart | 6 ++++++ .../spellchecker/spellchecker_service.dart | 6 ++++++ .../spellchecker_service_provider.dart | 8 ++++++++ 7 files changed, 44 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 27639a50..8740c042 100644 --- a/README.md +++ b/README.md @@ -308,7 +308,7 @@ A spell checker is a software tool or feature integrated into various text proce * **Portuguese** - `pt` (may contain errors or missing words) * **Swedish** - `sv` (may contain errors or missing words) -_**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](https://github.com/CatHood0/simple_spell_checker)_. +_**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](https://github.com/CatHood0/simple_spell_checker)_. In order to activate this functionality you can use the following code: @@ -324,7 +324,8 @@ When you no longer need to have the Spell checker activated you can simply use ` // dispose all service and it cannot be used after this SpellCheckerServiceProvider.dispose(); ``` -If what we want is to **temporarily deactivate the service** without deleting the values that are already stored in it, we can set `onlyPartial` to `true` so that it only closes the internal `streams` and prevents the dictionaries and values already registered from being reset. + +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`. ```dart // it can be still used by the editor @@ -334,16 +335,10 @@ 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: ```dart -final bool _isActivatedSpellChecker = false; -if (!_isActivatedSpellChecker) { - FlutterQuillExtensions.useSpellCheckerService(Localizations.localeOf(context).languageCode); -} else { - // close the internal streams without completely closing the service - SpellCheckerServiceProvider.dispose(onlyPartial: true); - // since onlyPartial is true then we must manually disable the service for it to take effect in the UI - SpellCheckerServiceProvider.turnOffService(); -} -_isActivatedSpellChecker = !_isActivatedSpellChecker; + SpellCheckerServiceProvider.toggleState(); + // use isServiceActive to get the state of the service + SpellCheckerServiceProvider.isServiceActive(); + setState(() {}); ``` Open this [page](https://pub.dev/packages/simple_spell_checker) for more information. diff --git a/example/lib/screens/quill/quill_screen.dart b/example/lib/screens/quill/quill_screen.dart index d4d00e97..db59e539 100644 --- a/example/lib/screens/quill/quill_screen.dart +++ b/example/lib/screens/quill/quill_screen.dart @@ -14,7 +14,7 @@ import '../shared/widgets/home_screen_button.dart'; import 'my_quill_editor.dart'; import 'my_quill_toolbar.dart'; -var _isActivatedSpellChecker = false; +var _isSpellcheckerActive = false; @immutable class QuillScreenArgs { @@ -61,6 +61,11 @@ class _QuillScreenState extends State { @override Widget build(BuildContext context) { _controller.readOnly = _isReadOnly; + if (!_isSpellcheckerActive) { + _isSpellcheckerActive = true; + FlutterQuillExtensions.useSpellCheckerService( + Localizations.localeOf(context).languageCode); + } return Scaffold( appBar: AppBar( title: const Text('Flutter Quill'), @@ -68,19 +73,14 @@ class _QuillScreenState extends State { IconButton( tooltip: 'Spell-checker', onPressed: () { - if (!_isActivatedSpellChecker) { - FlutterQuillExtensions.useSpellCheckerService( - Localizations.localeOf(context).languageCode); - } else { - SpellCheckerServiceProvider.dispose(onlyPartial: true); - SpellCheckerServiceProvider.turnOffService(); - } - _isActivatedSpellChecker = !_isActivatedSpellChecker; + SpellCheckerServiceProvider.toggleState(); setState(() {}); }, icon: Icon( Icons.document_scanner, - color: _isActivatedSpellChecker ? Colors.red : null, + color: SpellCheckerServiceProvider.isServiceActive() + ? Colors.red.withOpacity(0.5) + : null, ), ), IconButton( diff --git a/flutter_quill_extensions/lib/src/editor/spell_checker/simple_spell_checker_service.dart b/flutter_quill_extensions/lib/src/editor/spell_checker/simple_spell_checker_service.dart index fe36678b..c804a8d1 100644 --- a/flutter_quill_extensions/lib/src/editor/spell_checker/simple_spell_checker_service.dart +++ b/flutter_quill_extensions/lib/src/editor/spell_checker/simple_spell_checker_service.dart @@ -31,6 +31,12 @@ class SimpleSpellCheckerService ); } + @override + void toggleChecker() => checker.toggleChecker(); + + @override + bool isServiceActive() => checker.isCheckerActive(); + @override void dispose({bool onlyPartial = false}) { if (onlyPartial) { diff --git a/flutter_quill_extensions/pubspec.yaml b/flutter_quill_extensions/pubspec.yaml index ddee44e3..8eb84cf1 100644 --- a/flutter_quill_extensions/pubspec.yaml +++ b/flutter_quill_extensions/pubspec.yaml @@ -41,7 +41,7 @@ dependencies: # Plugins video_player: ^2.8.1 - simple_spell_checker: ^1.1.2 + simple_spell_checker: ^1.1.6 youtube_player_flutter: ^9.0.1 url_launcher: ^6.2.1 super_clipboard: ^0.8.15 diff --git a/lib/src/editor/spellchecker/default_spellchecker_service.dart b/lib/src/editor/spellchecker/default_spellchecker_service.dart index cfeb1a12..4a8e6b1a 100644 --- a/lib/src/editor/spellchecker/default_spellchecker_service.dart +++ b/lib/src/editor/spellchecker/default_spellchecker_service.dart @@ -28,4 +28,10 @@ class DefaultSpellCheckerService extends SpellCheckerService { @override void updateCustomLanguageIfExist({languageIdentifier}) {} + + @override + bool isServiceActive() => false; + + @override + void toggleChecker() {} } diff --git a/lib/src/editor/spellchecker/spellchecker_service.dart b/lib/src/editor/spellchecker/spellchecker_service.dart index b8331420..0e2ebd48 100644 --- a/lib/src/editor/spellchecker/spellchecker_service.dart +++ b/lib/src/editor/spellchecker/spellchecker_service.dart @@ -7,6 +7,12 @@ abstract class SpellCheckerService { final String language; + /// Decide if the service should be activate or deactivate + /// without dispose the service + void toggleChecker(); + + bool isServiceActive(); + /// dispose all the resources used for SpellcheckerService /// /// if [onlyPartial] is true just dispose a part of the SpellcheckerService diff --git a/lib/src/editor/spellchecker/spellchecker_service_provider.dart b/lib/src/editor/spellchecker/spellchecker_service_provider.dart index 24a51ebf..e5d41335 100644 --- a/lib/src/editor/spellchecker/spellchecker_service_provider.dart +++ b/lib/src/editor/spellchecker/spellchecker_service_provider.dart @@ -17,6 +17,14 @@ class SpellCheckerServiceProvider { _instance.dispose(onlyPartial: onlyPartial); } + static void toggleState() { + _instance.toggleChecker(); + } + + static bool isServiceActive() { + return _instance.isServiceActive(); + } + static void setNewLanguageState({required String language}) { assert(language.isNotEmpty); _instance.setNewLanguageState(language: language);