change controller name

Author: solid-danylokhvan

README.md

@@ -52,11 +52,11 @@ To start using the plugin, copy this code or follow the example project in 'lang
 
 ```dart
 // Create a text controller for the Widget
-final _controller = ColoredTextEditingController();
+final _controller = LanguageToolController();
 
 // Use the text field widget in your layout
 child: LanguageToolTextField(
-  coloredController: _controller,
+  controller: _controller,
 
   // A language code like en-US, de-DE, fr, or auto to guess
   // the language automatically.
@@ -72,9 +72,9 @@ _controller.dispose();
 
 To incorporate the debounce or throttle functionality into the `LanguageTool TextField`, follow these steps:
 
-Create a `LanguageToolTextEditingController` and provide the desired debounce/throttle delay duration and delay type:
+Create a `LanguageToolController` and provide the desired debounce/throttle delay duration and delay type:
    ```dart
-   final _controller = LanguageToolTextEditingController(
+   final _controller = LanguageToolController(
      // If the delay value is [Duration.zero], no delay is applied.
      delay: Duration(milliseconds: 500), // Set the debounce/throttle delay duration here
      delayType: DelayType.debouncing, // Choose either DelayType.debouncing or DelayType.throttling

example/lib/main.dart

@@ -21,8 +21,7 @@ class App extends StatefulWidget {
 
 class _AppState extends State<App> {
   /// Initialize LanguageToolTextEditingController
-  final LanguageToolTextEditingController _controller =
-      LanguageToolTextEditingController();
+  final LanguageToolController _controller = LanguageToolController();
 
   static const List<MainAxisAlignment> alignments = [
     MainAxisAlignment.center,
@@ -39,7 +38,7 @@ class _AppState extends State<App> {
           mainAxisAlignment: alignments[currentAlignmentIndex],
           children: [
             LanguageToolTextField(
-              coloredController: _controller,
+              controller: _controller,
 
               // A language code like en-US, de-DE, fr, or auto to guess
               // the language automatically.

…nguage_tool_text_editing_controller.dart …ontrollers/language_tool_controller.dartlib/core/controllers/language_tool_text_editing_controller.dart renamed to lib/core/controllers/language_tool_controller.dart lib/core/controllers/language_tool_text_editing_controller.dart renamed to lib/core/controllers/language_tool_controller.dart

@@ -18,7 +18,7 @@ import 'package:languagetool_textfield/utils/mistake_popup.dart';
 
 /// A TextEditingController with overrides buildTextSpan for building
 /// marked TextSpans with tap recognizer
-class LanguageToolTextEditingController extends TextEditingController {
+class LanguageToolController extends TextEditingController {
   /// Color scheme to highlight mistakes
   final HighlightStyle highlightStyle;
 
@@ -83,7 +83,7 @@ class LanguageToolTextEditingController extends TextEditingController {
   }
 
   /// Controller constructor
-  LanguageToolTextEditingController({
+  LanguageToolController({
     this.highlightStyle = const HighlightStyle(),
     this.delay = Duration.zero,
     this.delayType = DelayType.debouncing,

lib/domain/typedefs.dart

@@ -1,13 +1,13 @@
 import 'package:flutter/widgets.dart';
-import 'package:languagetool_textfield/core/controllers/language_tool_text_editing_controller.dart';
+import 'package:languagetool_textfield/core/controllers/language_tool_controller.dart';
 import 'package:languagetool_textfield/domain/mistake.dart';
 import 'package:languagetool_textfield/utils/popup_overlay_renderer.dart';
 
 /// Callback used to build popup body
 typedef MistakeBuilderCallback = Widget Function({
   required PopupOverlayRenderer popupRenderer,
   required Mistake mistake,
-  required LanguageToolTextEditingController controller,
+  required LanguageToolController controller,
   required Offset mistakePosition,
 });
 
@@ -16,5 +16,5 @@ typedef ShowPopupCallback = void Function(
   BuildContext context,
   Mistake mistake,
   Offset mistakePosition,
-  LanguageToolTextEditingController controller,
+  LanguageToolController controller,
 );

lib/languagetool_textfield.dart

@@ -1,7 +1,7 @@
 library languagetool_textfield;
 
 export 'client/language_tool_client.dart';
-export 'core/controllers/language_tool_text_editing_controller.dart';
+export 'core/controllers/language_tool_controller.dart';
 export 'core/enums/delay_type.dart';
 export 'core/model/category.dart';
 export 'core/model/language_tool_raw.dart';

lib/presentation/language_tool_text_field.dart

@@ -1,10 +1,10 @@
 import 'package:flutter/material.dart';
-import 'package:languagetool_textfield/core/controllers/language_tool_text_editing_controller.dart';
+import 'package:languagetool_textfield/core/controllers/language_tool_controller.dart';
 import 'package:languagetool_textfield/utils/mistake_popup.dart';
 import 'package:languagetool_textfield/utils/popup_overlay_renderer.dart';
 
 /// A TextField widget that checks the grammar using the given
-/// [coloredController]
+/// [LanguageToolController]
 class LanguageToolTextField extends StatefulWidget {
   /// A style to use for the text being edited.
   final TextStyle? style;
@@ -13,7 +13,7 @@ class LanguageToolTextField extends StatefulWidget {
   final InputDecoration decoration;
 
   /// Color scheme to highlight mistakes
-  final LanguageToolTextEditingController coloredController;
+  final LanguageToolController controller;
 
   /// Mistake popup window
   final MistakePopup? mistakePopup;
@@ -34,7 +34,7 @@ class LanguageToolTextField extends StatefulWidget {
 
   /// Creates a widget that checks grammar errors.
   const LanguageToolTextField({
-    required this.coloredController,
+    required this.controller,
     this.style,
     this.decoration = const InputDecoration(),
     this.language = 'auto',
@@ -58,7 +58,7 @@ class _LanguageToolTextFieldState extends State<LanguageToolTextField> {
   @override
   void initState() {
     super.initState();
-    final controller = widget.coloredController;
+    final controller = widget.controller;
 
     controller.focusNode = _focusNode;
     controller.language = widget.language;
@@ -71,17 +71,16 @@ class _LanguageToolTextFieldState extends State<LanguageToolTextField> {
   @override
   Widget build(BuildContext context) {
     return ListenableBuilder(
-      listenable: widget.coloredController,
+      listenable: widget.controller,
       builder: (_, __) {
-        final fetchError = widget.coloredController.fetchError;
+        final fetchError = widget.controller.fetchError;
 
         // it would probably look much better if the error would be shown on a
         // dedicated panel with field options
         final httpErrorText = Text(
           '$fetchError',
           style: TextStyle(
-            color:
-                widget.coloredController.highlightStyle.misspellingMistakeColor,
+            color: widget.controller.highlightStyle.misspellingMistakeColor,
           ),
         );
 
@@ -94,7 +93,7 @@ class _LanguageToolTextFieldState extends State<LanguageToolTextField> {
           child: Center(
             child: TextField(
               focusNode: _focusNode,
-              controller: widget.coloredController,
+              controller: widget.controller,
               scrollController: _scrollController,
               decoration: inputDecoration,
               minLines: widget.minLines,
@@ -109,7 +108,7 @@ class _LanguageToolTextFieldState extends State<LanguageToolTextField> {
   }
 
   void _textControllerListener() =>
-      widget.coloredController.scrollOffset = _scrollController.offset;
+      widget.controller.scrollOffset = _scrollController.offset;
 
   @override
   void dispose() {

lib/utils/mistake_popup.dart

@@ -2,10 +2,12 @@ import 'dart:math';
 
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
+import 'package:languagetool_textfield/core/controllers/language_tool_controller.dart';
 import 'package:languagetool_textfield/core/langtool_images.dart';
+import 'package:languagetool_textfield/domain/mistake.dart';
 import 'package:languagetool_textfield/domain/typedefs.dart';
-import 'package:languagetool_textfield/languagetool_textfield.dart';
 import 'package:languagetool_textfield/utils/extensions/string_extension.dart';
+import 'package:languagetool_textfield/utils/popup_overlay_renderer.dart';
 
 /// Builder class that uses specified [popupRenderer] and [mistakeBuilder]
 /// to create mistake popup
@@ -24,7 +26,7 @@ class MistakePopup {
     BuildContext context, {
     required Mistake mistake,
     required Offset popupPosition,
-    required LanguageToolTextEditingController controller,
+    required LanguageToolController controller,
     ValueChanged<TapDownDetails>? onClose,
   }) {
     final MistakeBuilderCallback builder =
@@ -58,7 +60,7 @@ class LanguageToolMistakePopup extends StatelessWidget {
   final Mistake mistake;
 
   /// Controller of the text where mistake was found
-  final LanguageToolTextEditingController controller;
+  final LanguageToolController controller;
 
   /// An on-screen position of the mistake
   final Offset mistakePosition;