Merge pull request #1465 from flutter-form-builder-ecosystem/feature/#1456-remove-deprecated-code

feat: #1456-remove-deprecated-code

Author: deandreamatias

.github/workflows/base.yaml

@@ -42,11 +42,13 @@ jobs:
       - name: Install dependencies
         run: flutter pub get
       - name: Format code
-        run: dart format --set-exit-if-changed .
+        run: dart format --set-exit-if-changed lib/ test/ example/
       - name: Analyze static code
         run: flutter analyze
       - name: Run tests
         run: flutter test --coverage
+      - name: Run fixes tests
+        run: dart fix --compare-to-golden test_fixes/
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5
         with:

analysis_options.yaml

@@ -1 +1,5 @@
 include: package:flutter_lints/flutter.yaml
+
+analyzer: 
+  exclude: 
+    - "test_fixes/**" 

example/lib/minimal_code_example.dart

@@ -44,7 +44,7 @@ class _ExamplePageState extends State<_ExamplePage> {
           key: _formKey,
           child: Column(
             children: [
-              FormBuilderFilterChip<String>(
+              FormBuilderFilterChips<String>(
                 decoration: const InputDecoration(
                   labelText: 'The language of my people',
                   enabled: false,

example/lib/sources/complete_form.dart

@@ -252,7 +252,7 @@ class _CompleteFormState extends State<CompleteForm> {
                     FormBuilderValidators.maxLength(3),
                   ]),
                 ),
-                FormBuilderFilterChip<String>(
+                FormBuilderFilterChips<String>(
                   autovalidateMode: AutovalidateMode.onUserInteraction,
                   decoration: const InputDecoration(
                       labelText: 'The language of my people'),
@@ -286,7 +286,7 @@ class _CompleteFormState extends State<CompleteForm> {
                     FormBuilderValidators.maxLength(3),
                   ]),
                 ),
-                FormBuilderChoiceChip<String>(
+                FormBuilderChoiceChips<String>(
                   autovalidateMode: AutovalidateMode.onUserInteraction,
                   decoration: const InputDecoration(
                       labelText:

lib/fix_data.yaml

@@ -0,0 +1,45 @@
+version: 1
+transforms:
+  - title: 'Remove deprecated maxChips property on FormBuilderFilterChip'
+    date: 2025-01-15
+    element:
+      uris: [ 'flutter_form_builder.dart' ]
+      constructor: ''
+      inClass: 'FormBuilderFilterChip'
+    changes:
+      - kind: 'removeParameter'
+        name: 'maxChips'
+  - title: 'Remove deprecated resetIcon property on FormBuilderDateTimePicker'
+    date: 2025-01-15
+    element:
+      uris: [ 'flutter_form_builder.dart' ]
+      constructor: ''
+      inClass: 'FormBuilderDateTimePicker'
+    changes:
+      - kind: 'removeParameter'
+        name: 'resetIcon'
+  - title: 'Remove deprecated onPopInvoked property on FormBuilder'
+    date: 2025-01-15
+    element:
+      uris: [ 'flutter_form_builder.dart' ]
+      constructor: ''
+      inClass: 'FormBuilder'
+    changes:
+      - kind: 'removeParameter'
+        name: 'onPopInvoked'
+  - title: 'Rename FormBuilderChoiceChip to be plural'
+    date: 2025-01-15
+    element:
+      uris: [ 'flutter_form_builder.dart' ]
+      class: 'FormBuilderChoiceChip'
+    changes:
+      - kind: 'rename'
+        newName: 'FormBuilderChoiceChips'
+  - title: 'Rename FormBuilderFilterChip to be plural'
+    date: 2025-01-15
+    element:
+      uris: [ 'flutter_form_builder.dart' ]
+      class: 'FormBuilderFilterChip'
+    changes:
+      - kind: 'rename'
+        newName: 'FormBuilderFilterChips'

lib/src/extensions/generic_validator.dart

@@ -1,4 +1,5 @@
 extension GenericValidator<T> on T? {
+  /// Check if the value is empty in a generic way
   bool emptyValidator() {
     if (this == null) return true;
     if (this is Iterable) return (this as Iterable).isEmpty;

lib/src/fields/form_builder_choice_chips.dart

@@ -2,7 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
 /// A list of `Chip`s that acts like radio buttons
-class FormBuilderChoiceChip<T> extends FormBuilderFieldDecoration<T> {
+class FormBuilderChoiceChips<T> extends FormBuilderFieldDecoration<T> {
   /// The list of items the user can select.
   final List<FormBuilderChipOption<T>> options;
 
@@ -344,7 +344,7 @@ class FormBuilderChoiceChip<T> extends FormBuilderFieldDecoration<T> {
   final String? tooltip;
 
   /// Creates a list of `Chip`s that acts like radio buttons
-  FormBuilderChoiceChip({
+  FormBuilderChoiceChips({
     super.autovalidateMode = AutovalidateMode.disabled,
     super.enabled,
     super.focusNode,
@@ -457,12 +457,12 @@ class FormBuilderChoiceChip<T> extends FormBuilderFieldDecoration<T> {
         });
 
   @override
-  FormBuilderFieldDecorationState<FormBuilderChoiceChip<T>, T> createState() =>
+  FormBuilderFieldDecorationState<FormBuilderChoiceChips<T>, T> createState() =>
       _FormBuilderChoiceChipState<T>();
 }
 
 class _FormBuilderChoiceChipState<T>
-    extends FormBuilderFieldDecorationState<FormBuilderChoiceChip<T>, T> {
+    extends FormBuilderFieldDecorationState<FormBuilderChoiceChips<T>, T> {
   void handleFocusChange() {
     setState(() {});
   }

lib/src/fields/form_builder_date_time_picker.dart

@@ -40,10 +40,6 @@ class FormBuilderDateTimePicker extends FormBuilderFieldDecoration<DateTime> {
   /// to noon. Explicitly set this to `null` to use the current time.
   final TimeOfDay initialTime;
 
-  @Deprecated(
-      'This property is no used anymore. Please use decoration.suffixIcon to set your desired icon')
-  final Widget? resetIcon;
-
   /// Called when an enclosing form is saved. The value passed will be `null`
   /// if [format] fails to parse the text.
   // final FormFieldSetter<DateTime> onSaved;
@@ -146,7 +142,6 @@ class FormBuilderDateTimePicker extends FormBuilderFieldDecoration<DateTime> {
     this.scrollPadding = const EdgeInsets.all(20.0),
     this.cursorWidth = 2.0,
     this.enableInteractiveSelection = true,
-    this.resetIcon = const Icon(Icons.close),
     this.initialTime = const TimeOfDay(hour: 12, minute: 0),
     this.keyboardType,
     this.textAlign = TextAlign.start,

lib/src/fields/form_builder_filter_chips.dart

@@ -3,7 +3,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
 /// Field with chips that acts like a list checkboxes.
-class FormBuilderFilterChip<T> extends FormBuilderFieldDecoration<List<T>> {
+class FormBuilderFilterChips<T> extends FormBuilderFieldDecoration<List<T>> {
   //TODO: Add documentation
   final Color? backgroundColor;
   final Color? disabledColor;
@@ -35,7 +35,7 @@ class FormBuilderFilterChip<T> extends FormBuilderFieldDecoration<List<T>> {
   final ShapeBorder avatarBorder;
 
   /// Creates field with chips that acts like a list checkboxes.
-  FormBuilderFilterChip({
+  FormBuilderFilterChips({
     super.autovalidateMode = AutovalidateMode.disabled,
     super.enabled,
     super.focusNode,
@@ -59,7 +59,7 @@ class FormBuilderFilterChip<T> extends FormBuilderFieldDecoration<List<T>> {
     this.labelPadding,
     this.labelStyle,
     this.materialTapTargetSize,
-    this.maxChips,
+    @Deprecated('Useless property. Please remove it.') this.maxChips,
     this.padding,
     this.pressElevation,
     this.runAlignment = WrapAlignment.start,
@@ -143,9 +143,9 @@ class FormBuilderFilterChip<T> extends FormBuilderFieldDecoration<List<T>> {
         );
 
   @override
-  FormBuilderFieldDecorationState<FormBuilderFilterChip<T>, List<T>>
+  FormBuilderFieldDecorationState<FormBuilderFilterChips<T>, List<T>>
       createState() => _FormBuilderFilterChipState<T>();
 }
 
 class _FormBuilderFilterChipState<T> extends FormBuilderFieldDecorationState<
-    FormBuilderFilterChip<T>, List<T>> {}
+    FormBuilderFilterChips<T>, List<T>> {}

lib/src/fields/form_builder_text_field.dart

@@ -424,6 +424,11 @@ class FormBuilderTextField extends FormBuilderFieldDecoration<String> {
     this.contentInsertionConfiguration,
     this.spellCheckConfiguration,
     this.clipBehavior = Clip.hardEdge,
+    @Deprecated(
+      'This property will be removed in the next Flutter stable versions. '
+      'Use FocusNode.canRequestFocus instead. '
+      'Ref: https://docs.flutter.dev/release/breaking-changes/can-request-focus',
+    )
     this.canRequestFocus = true,
     this.cursorErrorColor,
     this.cursorOpacityAnimates,

lib/src/form_builder.dart

@@ -10,9 +10,6 @@ class FormBuilder extends StatefulWidget {
   /// will rebuild.
   final VoidCallback? onChanged;
 
-  /// DEPRECATED: Use [onPopInvokedWithResult] instead.
-  final void Function(bool)? onPopInvoked;
-
   /// {@macro flutter.widgets.navigator.onPopInvokedWithResult}
   ///
   /// {@tool dartpad}
@@ -105,11 +102,6 @@ class FormBuilder extends StatefulWidget {
     required this.child,
     this.onChanged,
     this.autovalidateMode,
-    @Deprecated(
-      'Use onPopInvokedWithResult instead. '
-      'This feature was deprecated after v3.22.0-12.0.pre.',
-    )
-    this.onPopInvoked,
     this.onPopInvokedWithResult,
     this.initialValue = const <String, dynamic>{},
     this.skipDisabled = false,
@@ -143,6 +135,7 @@ class FormBuilderState extends State<FormBuilder> {
   /// Only used to internal logic
   bool get focusOnInvalid => _focusOnInvalid;
 
+  /// Get if form is enabled
   bool get enabled => widget.enabled;
 
   /// Verify if all fields on form are valid.
@@ -171,6 +164,7 @@ class FormBuilderState extends State<FormBuilder> {
   /// Get all fields of form.
   FormBuilderFields get fields => _fields;
 
+  /// Get all fields values of form.
   Map<String, dynamic> get instantValue => Map<String, dynamic>.unmodifiable(
         _instantValue.map(
           (key, value) => MapEntry(
@@ -204,15 +198,18 @@ class FormBuilderState extends State<FormBuilder> {
         initialValue[name];
   }
 
+  /// Get a field value by name
   void setInternalFieldValue<T>(String name, T? value) {
     _instantValue[name] = value;
     widget.onChanged?.call();
   }
 
+  /// Remove a field value by name
   void removeInternalFieldValue(String name) {
     _instantValue.remove(name);
   }
 
+  /// Register a field on form
   void registerField(String name, FormBuilderFieldState field) {
     // Each field must have a unique name.  Ideally we could simply:
     //   assert(!_fields.containsKey(name));
@@ -242,6 +239,7 @@ class FormBuilderState extends State<FormBuilder> {
     );
   }
 
+  /// Unregister a field on form
   void unregisterField(String name, FormBuilderFieldState field) {
     assert(
       _fields.containsKey(name),
@@ -270,23 +268,14 @@ class FormBuilderState extends State<FormBuilder> {
     }
   }
 
+  /// Save form values
   void save() {
     _formKey.currentState!.save();
     // Copy values from instant to saved
     _savedValue.clear();
     _savedValue.addAll(_instantValue);
   }
 
-  @Deprecated(
-      'Will be remove to avoid redundancy. Use fields[name]?.invalidate(errorText) instead')
-  void invalidateField({required String name, String? errorText}) =>
-      fields[name]?.invalidate(errorText ?? '');
-
-  @Deprecated(
-      'Will be remove to avoid redundancy. Use fields.first.invalidate(errorText) instead')
-  void invalidateFirstField({required String errorText}) =>
-      fields.values.first.invalidate(errorText);
-
   /// Validate all fields of form
   ///
   /// Focus to first invalid field when has field invalid, if [focusOnInvalid] is `true`.
@@ -343,7 +332,7 @@ class FormBuilderState extends State<FormBuilder> {
     );
   }
 
-  /// Reset form to `initialValue`
+  /// Reset form to `initialValue` set on FormBuilder or on each field.
   void reset() {
     _formKey.currentState?.reset();
   }
@@ -376,8 +365,6 @@ class FormBuilderState extends State<FormBuilder> {
       key: _formKey,
       autovalidateMode: widget.autovalidateMode,
       onPopInvokedWithResult: widget.onPopInvokedWithResult,
-      // ignore: deprecated_member_use
-      onPopInvoked: widget.onPopInvoked,
       canPop: widget.canPop,
       // `onChanged` is called during setInternalFieldValue else will be called early
       child: _FormBuilderScope(

lib/src/form_builder_field.dart

@@ -71,12 +71,17 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
   FormBuilderState? _formBuilderState;
   bool _touched = false;
   bool _dirty = false;
+
+  /// The focus node that is used to focus this field.
   late FocusNode effectiveFocusNode;
+
+  /// The focus attachment for the [effectiveFocusNode].
   FocusAttachment? focusAttachment;
 
   @override
   F get widget => super.widget as F;
 
+  /// Returns the parent [FormBuilderState] if it exists.
   FormBuilderState? get formState => _formBuilderState;
 
   /// Returns the initial value, which may be declared at the field, or by the
@@ -91,18 +96,33 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
       widget.valueTransformer == null ? value : widget.valueTransformer!(value);
 
   @override
+
+  /// Returns the current error text,
+  /// which may be a validation error or a custom error text.
   String? get errorText => super.errorText ?? _customErrorText;
 
   @override
+
+  /// Returns `true` if the field has an error or has a custom error text.
   bool get hasError => super.hasError || errorText != null;
 
   @override
+
+  /// Returns `true` if the field is valid and has no custom error text.
   bool get isValid => super.isValid && _customErrorText == null;
 
+  /// Returns `true` if the field is valid.
   bool get valueIsValid => super.isValid;
+
+  /// Returns `true` if the field has an error.
   bool get valueHasError => super.hasError;
 
+  /// Returns `true` if the field is enabled and the parent FormBuilder is enabled.
   bool get enabled => widget.enabled && (_formBuilderState?.enabled ?? true);
+
+  /// Returns `true` if the field is read only.
+  ///
+  /// See [FormBuilder.skipDisabled] for more information.
   bool get readOnly => !(_formBuilderState?.widget.skipDisabled ?? false);
 
   /// Will be true if the field is dirty
@@ -199,6 +219,10 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
   }
 
   @override
+
+  /// Reset field value to initial value
+  ///
+  /// Also reset custom error text if exists, and set [isDirty] to `false`.
   void reset() {
     super.reset();
     didChange(initialValue);
@@ -276,10 +300,12 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
     );
   }
 
+  /// Focus field
   void focus() {
     FocusScope.of(context).requestFocus(effectiveFocusNode);
   }
 
+  /// Scroll to show field
   void ensureScrollableVisibility() {
     Scrollable.ensureVisible(context);
   }

lib/src/form_builder_field_decoration.dart

@@ -40,6 +40,7 @@ class FormBuilderFieldDecorationState<F extends FormBuilderFieldDecoration<T>,
   @override
   F get widget => super.widget as F;
 
+  /// Get the decoration with the current state
   InputDecoration get decoration => widget.decoration.copyWith(
         // Read only allow show error to support property skipDisabled
         errorText: widget.enabled || readOnly