Auto scroll to error + Custom error (#856)

* Removed widget.decoration?.errorText

* hotfix

* auto scroll to error + focus on first wrongfield

* custom error invalidation added

* package bump

* flutter 2.0

* Update

* Testing

* Test

* Test

* Flutter null safety

* ios update

* cleaning code

* Create extension.dart

* extension's export added

* Update form_builder_field.dart

Co-authored-by: Raphael <[email protected]>
Co-authored-by: Tez <[email protected]>

Author: 3 people

example/ios/Flutter/Debug.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"
 #include "Generated.xcconfig"

example/ios/Flutter/Release.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"
 #include "Generated.xcconfig"

example/ios/Podfile

@@ -0,0 +1,41 @@
+# Uncomment this line to define a global platform for your project
+# platform :ios, '9.0'
+
+# CocoaPods analytics sends network stats synchronously affecting flutter build latency.
+ENV['COCOAPODS_DISABLE_STATS'] = 'true'
+
+project 'Runner', {
+  'Debug' => :debug,
+  'Profile' => :release,
+  'Release' => :release,
+}
+
+def flutter_root
+  generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'Generated.xcconfig'), __FILE__)
+  unless File.exist?(generated_xcode_build_settings_path)
+    raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first"
+  end
+
+  File.foreach(generated_xcode_build_settings_path) do |line|
+    matches = line.match(/FLUTTER_ROOT\=(.*)/)
+    return matches[1].strip if matches
+  end
+  raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get"
+end
+
+require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root)
+
+flutter_ios_podfile_setup
+
+target 'Runner' do
+  use_frameworks!
+  use_modular_headers!
+
+  flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
+end
+
+post_install do |installer|
+  installer.pods_project.targets.each do |target|
+    flutter_additional_ios_build_settings(target)
+  end
+end

lib/flutter_form_builder.dart

@@ -20,3 +20,4 @@ export './src/form_builder_field_option.dart';
 export './src/form_builder_validators.dart';
 export './src/widgets/grouped_checkbox.dart';
 export './src/widgets/grouped_radio.dart';
+export './src/utils/extension.dart';

lib/src/form_builder.dart

@@ -94,12 +94,6 @@ class FormBuilderState extends State<FormBuilder> {
 
   Map<String, FormBuilderFieldState> get fields => _fields;
 
-  /*
-    bool get hasError => _fields.values.map((e) => e.hasError).firstWhere((element) => element == false, orElse: () => true);
-
-    bool get isValid => _fields.values.map((e) => e.isValid).firstWhere((element) => element == false, orElse: () => true);
-  */
-
   void setInternalFieldValue(String name, dynamic value) {
     setState(() {
       _value[name] = value;
@@ -153,7 +147,13 @@ class FormBuilderState extends State<FormBuilder> {
   }
 
   bool validate() {
-    return _formKey.currentState!.validate();
+    final validation = _formKey.currentState!.validate();
+    if (!validation) {
+      final wrongFields =
+          fields.values.where((element) => element.hasError).toList();
+      wrongFields.first.requestFocus();
+    }
+    return validation;
   }
 
   bool saveAndValidate() {

lib/src/form_builder_field.dart

@@ -83,6 +83,8 @@ class FormBuilderField<T> extends FormField<T?> {
 
 class FormBuilderFieldState<F extends FormBuilderField<T?>, T>
     extends FormFieldState<T?> {
+  String? _customError;
+
   @override
   F get widget => super.widget as F;
 
@@ -174,15 +176,26 @@ class FormBuilderFieldState<F extends FormBuilderField<T?>, T>
 
   @override
   bool validate() {
+    setState(() {
+      _customError = null;
+    });
     return super.validate() && widget.decoration.errorText == null;
   }
 
   void requestFocus() {
     FocusScope.of(context).requestFocus(effectiveFocusNode);
+    Scrollable.ensureVisible(context);
+  }
+
+  void invalidateField(String reason) {
+    requestFocus();
+    setState(() {
+      _customError = reason;
+    });
   }
 
   //  FIXME: This  could be a getter instead of a classic function
   InputDecoration decoration() => widget.decoration.copyWith(
-        errorText: widget.decoration.errorText ?? errorText,
-      );
+      errorText: widget.decoration.errorText ?? errorText ?? _customError,
+    );
 }

lib/src/utils/extension.dart

@@ -0,0 +1,13 @@
+import 'package:flutter/widgets.dart';
+import 'package:flutter_form_builder/flutter_form_builder.dart';
+
+extension FormKey on GlobalKey<FormBuilderState> {
+  void invalidateField({
+    required String name,
+    String? reason,
+  }) =>
+      currentState?.fields[name]?.invalidateField(reason ?? '');
+
+  void invalidateFirstField({required String reason}) =>
+      currentState?.fields.values.first.invalidateField(reason);
+}

pubspec.yaml

@@ -12,8 +12,28 @@ dependencies:
   flutter_localizations:
     sdk: flutter
 
+  community_material_icon: ^5.4.55
+  country_pickers: ^2.0.0
+  date_range_picker: ^1.0.6
+  datetime_picker_formfield: ^2.0.0
+  dropdown_search: ^0.6.3
+  file_picker: ^3.0.3
+  flutter_colorpicker: ^0.5.0
+  flutter_chips_input: ^1.9.5
+  flutter_datetime_picker: ^1.4.0
+  flutter_touch_spin: ^2.0.0-nullsafety.1
+  flutter_typeahead: "<=1.9.1"
+  image_picker: ^0.8.2
+  image_picker_for_web: ^2.1.1
+  intl: ^0.17.0
+  permission_handler: ^8.1.3
+  phone_number: ^0.11.0+1
+  rating_bar: ^0.2.0
+  signature: ^4.1.1
+  validators: ^3.0.0
+
+dependency_overrides:
   intl: ^0.17.0
-  collection: ^1.15.0
 
 dev_dependencies:
   flutter_test: