Merge pull request #90 from andrew-bekhiet-solid/feat-add-missing-text-field-properties

illia-romanenko · web-flow · commit b9f4a1986d7f · 2025-08-11T18:29:19.000-05:00
feat: add missing text field properties
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,52 @@
+## 1.0.0
+
+- BREAKING: rename autoFocus to autofocus to match `TextField`'s naming
+- Add missing properties from flutter's `TextField`
+  - autofillHints
+  - autofocus
+  - buildCounter
+  - canRequestFocus
+  - clipBehavior
+  - contentInsertionConfiguration
+  - contextMenuBuilder
+  - cursorErrorColor
+  - cursorHeight
+  - cursorOpacityAnimates
+  - cursorRadius
+  - cursorWidth
+  - dragStartBehavior
+  - enabled
+  - enableIMEPersonalizedLearning
+  - enableInteractiveSelection
+  - enableSuggestions
+  - ignorePointers
+  - inputFormatters
+  - key
+  - magnifierConfiguration
+  - maxLength
+  - maxLengthEnforcement
+  - obscureText
+  - obscuringCharacter
+  - onTapAlwaysCalled
+  - onTapUpOutside
+  - restorationId
+  - scrollController
+  - scrollPadding
+  - scrollPhysics
+  - selectionControls
+  - selectionHeightStyle
+  - selectionWidthStyle
+  - showCursor
+  - smartDashesType
+  - smartQuotesType
+  - spellCheckConfiguration
+  - statesController
+  - strutStyle
+  - stylusHandwritingEnabled
+  - textAlignVertical
+  - textCapitalization
+  - undoController
+
 ## 0.1.1
 
 - Fix changelog
@@ -13,7 +62,7 @@
 ## 0.0.6
 
 - Add textAlign and textDirection arguments to LanguageToolTextField constructor
-- Enforce utf-8 decoding format for LanguageTool API responses. 
+- Enforce utf-8 decoding format for LanguageTool API responses.
 
 Credits: @Semsem-programmer
 
diff --git a/lib/src/presentation/language_tool_text_field.dart b/lib/src/presentation/language_tool_text_field.dart
@@ -5,81 +5,91 @@ import 'package:languagetool_textfield/src/utils/popup_overlay_renderer.dart';
 
 /// A TextField widget that checks the grammar using the given
 /// [LanguageToolController]
-class LanguageToolTextField extends StatefulWidget {
-  /// A style to use for the text being edited.
-  final TextStyle? style;
-
-  /// A decoration of this [TextField].
-  final InputDecoration decoration;
-
-  /// Color scheme to highlight mistakes
-  final LanguageToolController controller;
+class LanguageToolTextField extends TextField {
+  /// LanguageToolController to highlight mistakes
+  @override
+  LanguageToolController get controller =>
+      super.controller as LanguageToolController? ?? LanguageToolController();
 
   /// Mistake popup window
   final MistakePopup? mistakePopup;
 
-  /// The maximum number of lines to show at one time, wrapping if necessary.
-  final int? maxLines;
-
-  /// The minimum number of lines to occupy when the content spans fewer lines.
-  final int? minLines;
-
-  /// Whether this widget's height will be sized to fill its parent.
-  final bool expands;
-
   /// A language code like en-US, de-DE, fr, or auto to guess
   /// the language automatically.
   /// ```language``` = 'auto' by default.
   final String language;
 
-  /// Determine text alignment
-  /// textAlign = [TextAlign.start] by default.
-  final TextAlign textAlign;
-
-  /// Determine text Direction
-  final TextDirection? textDirection;
-
-  final ValueChanged<String>? onTextChange;
-  final ValueChanged<String>? onTextSubmitted;
-  final VoidCallback? onTap;
-  final TapRegionCallback? onTapOutside;
-  final TextInputAction? textInputAction;
-  final TextInputType? keyboardType;
-  final Color? cursorColor;
-  final bool autoFocus;
-  final FocusNode? focusNode;
-  final Brightness? keyboardAppearance;
-  final bool autocorrect;
-  final bool readOnly;
-  final MouseCursor? mouseCursor;
+  /// Whether to center align the text field widget.
   final bool alignCenter;
 
   /// Creates a widget that checks grammar errors.
   const LanguageToolTextField({
-    required this.controller,
-    this.style,
-    this.decoration = const InputDecoration(),
-    this.language = 'auto',
+    required LanguageToolController super.controller,
     this.mistakePopup,
-    this.maxLines = 1,
-    this.minLines,
-    this.expands = false,
-    this.textAlign = TextAlign.start,
-    this.textDirection,
-    this.cursorColor,
-    this.autocorrect = true,
-    this.autoFocus = false,
-    this.readOnly = false,
-    this.textInputAction,
-    this.keyboardType,
-    this.focusNode,
-    this.keyboardAppearance,
-    this.mouseCursor,
-    this.onTap,
-    this.onTapOutside,
-    this.onTextChange,
-    this.onTextSubmitted,
+    this.language = 'auto',
     this.alignCenter = true,
+    super.onChanged,
+    super.onSubmitted,
+    super.focusNode,
+    super.undoController,
+    super.decoration,
+    super.keyboardType,
+    super.textInputAction,
+    super.textCapitalization,
+    super.style,
+    super.strutStyle,
+    super.textAlign,
+    super.textAlignVertical,
+    super.textDirection,
+    super.readOnly,
+    super.showCursor,
+    super.autofocus,
+    super.statesController,
+    super.obscuringCharacter,
+    super.obscureText,
+    super.autocorrect,
+    super.smartDashesType,
+    super.smartQuotesType,
+    super.enableSuggestions,
+    super.maxLines,
+    super.minLines,
+    super.expands,
+    super.maxLength,
+    super.maxLengthEnforcement,
+    super.inputFormatters,
+    super.enabled,
+    super.ignorePointers,
+    super.cursorWidth,
+    super.cursorHeight,
+    super.cursorRadius,
+    super.cursorOpacityAnimates,
+    super.cursorColor,
+    super.cursorErrorColor,
+    super.selectionHeightStyle,
+    super.selectionWidthStyle,
+    super.keyboardAppearance,
+    super.scrollPadding,
+    super.dragStartBehavior,
+    super.enableInteractiveSelection,
+    super.selectionControls,
+    super.onTap,
+    super.onTapAlwaysCalled,
+    super.onTapOutside,
+    super.onTapUpOutside,
+    super.mouseCursor,
+    super.buildCounter,
+    super.scrollController,
+    super.scrollPhysics,
+    super.autofillHints,
+    super.contentInsertionConfiguration,
+    super.clipBehavior,
+    super.restorationId,
+    super.stylusHandwritingEnabled,
+    super.enableIMEPersonalizedLearning,
+    super.contextMenuBuilder,
+    super.canRequestFocus,
+    super.spellCheckConfiguration,
+    super.magnifierConfiguration,
     super.key,
   });
 
@@ -121,33 +131,76 @@ class _LanguageToolTextFieldState extends State<LanguageToolTextField> {
           ),
         );
 
-        final inputDecoration = widget.decoration.copyWith(
+        final inputDecoration = widget.decoration?.copyWith(
           suffix: fetchError != null ? httpErrorText : null,
         );
 
         Widget childWidget = TextField(
-          textAlign: widget.textAlign,
-          textDirection: widget.textDirection,
-          focusNode: _focusNode,
           controller: widget.controller,
+          focusNode: _focusNode,
           scrollController: _scrollController,
           decoration: inputDecoration,
-          minLines: widget.minLines,
+          keyboardType: widget.keyboardType,
+          textInputAction: widget.textInputAction,
+          textCapitalization: widget.textCapitalization,
+          style: widget.style,
+          strutStyle: widget.strutStyle,
+          textAlign: widget.textAlign,
+          textAlignVertical: widget.textAlignVertical,
+          textDirection: widget.textDirection,
+          autofocus: widget.autofocus,
+          statesController: widget.statesController,
+          readOnly: widget.readOnly,
+          showCursor: widget.showCursor,
+          obscuringCharacter: widget.obscuringCharacter,
+          obscureText: widget.obscureText,
+          autocorrect: widget.autocorrect,
+          smartDashesType: widget.smartDashesType,
+          smartQuotesType: widget.smartQuotesType,
+          enableSuggestions: widget.enableSuggestions,
+          maxLengthEnforcement: widget.maxLengthEnforcement,
           maxLines: widget.maxLines,
+          minLines: widget.minLines,
           expands: widget.expands,
-          style: widget.style,
+          maxLength: widget.maxLength,
+          onChanged: widget.onChanged,
+          onTap: widget.onTap,
+          onTapAlwaysCalled: widget.onTapAlwaysCalled,
+          onTapOutside: widget.onTapOutside,
+          onTapUpOutside: widget.onTapUpOutside,
+          onEditingComplete: widget.onEditingComplete,
+          onSubmitted: widget.onSubmitted,
+          inputFormatters: widget.inputFormatters,
+          enabled: widget.enabled,
+          ignorePointers: widget.ignorePointers,
+          cursorWidth: widget.cursorWidth,
+          cursorHeight: widget.cursorHeight,
+          cursorRadius: widget.cursorRadius,
           cursorColor: widget.cursorColor,
-          autocorrect: widget.autocorrect,
-          textInputAction: widget.textInputAction,
+          cursorErrorColor: widget.cursorErrorColor,
+          scrollPadding: widget.scrollPadding,
+          scrollPhysics: widget.scrollPhysics,
           keyboardAppearance: widget.keyboardAppearance,
-          keyboardType: widget.keyboardType,
-          autofocus: widget.autoFocus,
-          readOnly: widget.readOnly,
+          enableInteractiveSelection: widget.enableInteractiveSelection,
+          selectionControls: widget.selectionControls,
+          buildCounter: widget.buildCounter,
+          autofillHints: widget.autofillHints,
           mouseCursor: widget.mouseCursor,
-          onChanged: widget.onTextChange,
-          onSubmitted: widget.onTextSubmitted,
-          onTap: widget.onTap,
-          onTapOutside: widget.onTapOutside,
+          contextMenuBuilder: widget.contextMenuBuilder,
+          spellCheckConfiguration: widget.spellCheckConfiguration,
+          magnifierConfiguration: widget.magnifierConfiguration,
+          undoController: widget.undoController,
+          onAppPrivateCommand: widget.onAppPrivateCommand,
+          cursorOpacityAnimates: widget.cursorOpacityAnimates,
+          selectionHeightStyle: widget.selectionHeightStyle,
+          selectionWidthStyle: widget.selectionWidthStyle,
+          dragStartBehavior: widget.dragStartBehavior,
+          contentInsertionConfiguration: widget.contentInsertionConfiguration,
+          clipBehavior: widget.clipBehavior,
+          stylusHandwritingEnabled: widget.stylusHandwritingEnabled,
+          canRequestFocus: widget.canRequestFocus,
+          enableIMEPersonalizedLearning: widget.enableIMEPersonalizedLearning,
+          restorationId: widget.restorationId,
         );
 
         if (widget.alignCenter) {
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,11 +1,10 @@
 name: languagetool_textfield
 description: The LanguageTool TextField package is a spell-checker designed for Flutter apps. This is useful for apps that need text input like messaging, notes, and email.
-version: 0.1.1
+version: 1.0.0
 homepage: https://github.com/solid-software/languagetool_textfield/
 
-
 environment:
-  sdk: '>=2.18.6 <4.0.0'
+  sdk: ">=2.18.6 <4.0.0"
   flutter: ">=1.17.0"
 
 dependencies:
@@ -14,8 +13,8 @@ dependencies:
   flutter:
     sdk: flutter
   http: ^1.0.0
-  throttling: ^2.0.1
   pointer_interceptor: ^0.10.1
+  throttling: ^2.0.1
 
 dev_dependencies:
   flutter_test:
