Merge pull request #545 from awhitford/skipDisabled

awhitford · web-flow · commit 628899328066 · 2020-11-06T01:24:13.000-08:00
Reworked exclusion of read-only/disabled/constant fields from save
diff --git a/README.md b/README.md
@@ -42,7 +42,6 @@ Column(
     FormBuilder(
       key: _formKey,
       autovalidate: true,
-      // readonly: true,
       child: Column(
         children: <Widget>[
           FormBuilderFilterChip(
@@ -399,7 +398,6 @@ In order to create an input field in the form, along with the label, and any app
 | `validator` | `FormFieldValidator<T>` | `null` | `No` | A `FormFieldValidator` that will check the validity of value in the `FormField` |
 | `onChanged` | `ValueChanged<T>` | `null` | `No` | This event function will fire immediately the the field value changes |
 | `valueTransformer` | `ValueTransformer<T>` | `null` | `No` | Function that transforms field value before saving to form value. e.g. transform TextField value for numeric field from `String` to `num` |
-| `saveValue` | `bool` | `true` | `No` | Determines whether the field and its value will be included in the final form value `Map` |
 The rest of the attributes will be determined by the type of Widget being used.
 
 ### Building your own custom field
diff --git a/example/lib/sources/complete_form.dart b/example/lib/sources/complete_form.dart
@@ -41,13 +41,14 @@ class CompleteFormState extends State<CompleteForm> {
                 'age': '13',
                 'gender': 'Male'
               },
+              skipDisabled: true,
               child: Column(
                 children: <Widget>[
                   FormBuilderSearchableDropdown(
                     name: 'searchable_dropdown',
                     items: allCountries,
                     onChanged: _onChanged,
-                    saveValue: false,
+                    enabled: false,
                   ),
                   FormBuilderLocationField(
                     name: 'location',
@@ -57,7 +58,7 @@ class CompleteFormState extends State<CompleteForm> {
                   const SizedBox(height: 15),
                   FormBuilderFilterChip(
                     name: 'filter_chip',
-                    saveValue: false,
+                    enabled: false,
                     decoration: const InputDecoration(
                       labelText: 'Select many options',
                     ),
diff --git a/lib/src/fields/form_builder_checkbox.dart b/lib/src/fields/form_builder_checkbox.dart
@@ -70,7 +70,6 @@ class FormBuilderCheckbox extends FormBuilderField<bool> {
     @required String name,
     FormFieldValidator<bool> validator,
     bool initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<bool> onChanged,
     ValueTransformer<bool> valueTransformer,
@@ -96,7 +95,6 @@ class FormBuilderCheckbox extends FormBuilderField<bool> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_checkbox_group.dart b/lib/src/fields/form_builder_checkbox_group.dart
@@ -30,7 +30,6 @@ class FormBuilderCheckboxGroup<T> extends FormBuilderField<List<T>> {
     @required String name,
     FormFieldValidator validator,
     List<T> initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<List<T>> onChanged,
     ValueTransformer<List<T>> valueTransformer,
@@ -65,7 +64,6 @@ class FormBuilderCheckboxGroup<T> extends FormBuilderField<List<T>> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_chips_input.dart b/lib/src/fields/form_builder_chips_input.dart
@@ -29,7 +29,6 @@ class FormBuilderChipsInput<T> extends FormBuilderField<List<T>> {
     @required String name,
     FormFieldValidator<List<T>> validator,
     List<T> initialValue = const [],
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<List<T>> onChanged,
     ValueTransformer<List<T>> valueTransformer,
@@ -61,7 +60,6 @@ class FormBuilderChipsInput<T> extends FormBuilderField<List<T>> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_choice_chips.dart b/lib/src/fields/form_builder_choice_chips.dart
@@ -244,7 +244,6 @@ class FormBuilderChoiceChip<T> extends FormBuilderField<T> {
     @required String name,
     FormFieldValidator<T> validator,
     T initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<T> onChanged,
     ValueTransformer<T> valueTransformer,
@@ -282,7 +281,6 @@ class FormBuilderChoiceChip<T> extends FormBuilderField<T> {
             validator: validator,
             valueTransformer: valueTransformer,
             onChanged: onChanged,
-            saveValue: saveValue,
             autovalidateMode: autovalidateMode,
             onSaved: onSaved,
             enabled: enabled,
diff --git a/lib/src/fields/form_builder_color_picker.dart b/lib/src/fields/form_builder_color_picker.dart
@@ -77,7 +77,6 @@ class FormBuilderColorPickerField extends FormBuilderField<Color> {
     ValueTransformer<Color> valueTransformer,
     ValueChanged<Color> onChanged,
     FormFieldSetter<Color> onSaved,
-    bool saveValue = true,
     VoidCallback onReset,
     this.controller,
     InputDecoration decoration = const InputDecoration(),
@@ -118,7 +117,6 @@ class FormBuilderColorPickerField extends FormBuilderField<Color> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_date_range_picker.dart b/lib/src/fields/form_builder_date_range_picker.dart
@@ -53,7 +53,6 @@ class FormBuilderDateRangePicker extends FormBuilderField<List<DateTime>> {
     @required String name,
     FormFieldValidator<List<DateTime>> validator,
     List<DateTime> initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<List<DateTime>> onChanged,
     ValueTransformer<List<DateTime>> valueTransformer,
@@ -122,7 +121,6 @@ class FormBuilderDateRangePicker extends FormBuilderField<List<DateTime>> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_date_time_picker.dart b/lib/src/fields/form_builder_date_time_picker.dart
@@ -151,7 +151,6 @@ class FormBuilderDateTimePicker extends FormBuilderField<DateTime> {
     @required String name,
     FormFieldValidator<DateTime> validator,
     DateTime initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<DateTime> onChanged,
     ValueTransformer<DateTime> valueTransformer,
@@ -226,7 +225,6 @@ class FormBuilderDateTimePicker extends FormBuilderField<DateTime> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_dropdown.dart b/lib/src/fields/form_builder_dropdown.dart
@@ -185,7 +185,6 @@ class FormBuilderDropdown<T> extends FormBuilderField<T> {
     @required String name,
     FormFieldValidator<T> validator,
     T initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<T> onChanged,
     ValueTransformer<T> valueTransformer,
@@ -220,7 +219,6 @@ class FormBuilderDropdown<T> extends FormBuilderField<T> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_file_picker.dart b/lib/src/fields/form_builder_file_picker.dart
@@ -47,7 +47,6 @@ class FormBuilderFilePicker extends FormBuilderField<List<PlatformFile>> {
     @required String name,
     FormFieldValidator<List<PlatformFile>> validator,
     List<PlatformFile> initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<List<PlatformFile>> onChanged,
     ValueTransformer<List<PlatformFile>> valueTransformer,
@@ -72,7 +71,6 @@ class FormBuilderFilePicker extends FormBuilderField<List<PlatformFile>> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_filter_chips.dart b/lib/src/fields/form_builder_filter_chips.dart
@@ -38,7 +38,6 @@ class FormBuilderFilterChip<T> extends FormBuilderField<List<T>> {
     @required String name,
     FormFieldValidator<List<T>> validator,
     List<T> initialValue = const [],
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<List<T>> onChanged,
     ValueTransformer<List<T>> valueTransformer,
@@ -82,7 +81,6 @@ class FormBuilderFilterChip<T> extends FormBuilderField<List<T>> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_image_picker.dart b/lib/src/fields/form_builder_image_picker.dart
@@ -44,7 +44,6 @@ class FormBuilderImagePicker extends FormBuilderField<List<dynamic>> {
     @required String name,
     FormFieldValidator validator,
     List<dynamic> initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<List<dynamic>> onChanged,
     ValueTransformer<List<dynamic>> valueTransformer,
@@ -77,7 +76,6 @@ class FormBuilderImagePicker extends FormBuilderField<List<dynamic>> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_location_field.dart b/lib/src/fields/form_builder_location_field.dart
@@ -170,7 +170,6 @@ class FormBuilderLocationField extends FormBuilderField<CameraPosition> {
     @required String name,
     FormFieldValidator validator,
     CameraPosition initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<CameraPosition> onChanged,
     ValueTransformer valueTransformer,
@@ -221,7 +220,6 @@ class FormBuilderLocationField extends FormBuilderField<CameraPosition> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_phone_field.dart b/lib/src/fields/form_builder_phone_field.dart
@@ -58,7 +58,6 @@ class FormBuilderPhoneField extends FormBuilderField<String> {
     @required String name,
     FormFieldValidator validator,
     String initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<String> onChanged,
     ValueTransformer<String> valueTransformer,
@@ -116,7 +115,6 @@ class FormBuilderPhoneField extends FormBuilderField<String> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_radio_group.dart b/lib/src/fields/form_builder_radio_group.dart
@@ -29,7 +29,6 @@ class FormBuilderRadioGroup<T> extends FormBuilderField<T> {
     @required String name,
     FormFieldValidator<T> validator,
     T initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<T> onChanged,
     ValueTransformer<T> valueTransformer,
@@ -62,7 +61,6 @@ class FormBuilderRadioGroup<T> extends FormBuilderField<T> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_range_slider.dart b/lib/src/fields/form_builder_range_slider.dart
@@ -109,7 +109,6 @@ class FormBuilderRangeSlider extends FormBuilderField<RangeValues> {
     @required String name,
     FormFieldValidator<RangeValues> validator,
     RangeValues initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<RangeValues> onChanged,
     ValueTransformer<RangeValues> valueTransformer,
@@ -139,7 +138,6 @@ class FormBuilderRangeSlider extends FormBuilderField<RangeValues> {
             validator: validator,
             valueTransformer: valueTransformer,
             onChanged: onChanged,
-            saveValue: saveValue,
             autovalidateMode: autovalidateMode,
             onSaved: onSaved,
             enabled: enabled,
diff --git a/lib/src/fields/form_builder_rating.dart b/lib/src/fields/form_builder_rating.dart
@@ -38,7 +38,6 @@ class FormBuilderRating extends FormBuilderField<double> {
     @required String name,
     FormFieldValidator<double> validator,
     double initialValue = 1.0,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<double> onChanged,
     ValueTransformer<double> valueTransformer,
@@ -63,7 +62,6 @@ class FormBuilderRating extends FormBuilderField<double> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_searchable_dropdown.dart b/lib/src/fields/form_builder_searchable_dropdown.dart
@@ -106,7 +106,6 @@ class FormBuilderSearchableDropdown<T> extends FormBuilderField<T> {
     @required String name,
     FormFieldValidator<T> validator,
     T initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<T> onChanged,
     ValueTransformer<T> valueTransformer,
@@ -152,7 +151,6 @@ class FormBuilderSearchableDropdown<T> extends FormBuilderField<T> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_segmented_control.dart b/lib/src/fields/form_builder_segmented_control.dart
@@ -41,7 +41,6 @@ class FormBuilderSegmentedControl<T> extends FormBuilderField<T> {
     @required String name,
     FormFieldValidator<T> validator,
     T initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<T> onChanged,
     ValueTransformer<T> valueTransformer,
@@ -63,7 +62,6 @@ class FormBuilderSegmentedControl<T> extends FormBuilderField<T> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_signature_pad.dart b/lib/src/fields/form_builder_signature_pad.dart
@@ -32,7 +32,6 @@ class FormBuilderSignaturePad extends FormBuilderField<Uint8List> {
     @required String name,
     FormFieldValidator<Uint8List> validator,
     Uint8List initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<Uint8List> onChanged,
     ValueTransformer<Uint8List> valueTransformer,
@@ -54,7 +53,6 @@ class FormBuilderSignaturePad extends FormBuilderField<Uint8List> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_slider.dart b/lib/src/fields/form_builder_slider.dart
@@ -133,7 +133,6 @@ class FormBuilderSlider extends FormBuilderField<double> {
     @required String name,
     FormFieldValidator<double> validator,
     @required double initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<double> onChanged,
     ValueTransformer<double> valueTransformer,
@@ -165,7 +164,6 @@ class FormBuilderSlider extends FormBuilderField<double> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_switch.dart b/lib/src/fields/form_builder_switch.dart
@@ -86,7 +86,6 @@ class FormBuilderSwitch extends FormBuilderField<bool> {
     @required String name,
     FormFieldValidator<bool> validator,
     bool initialValue,
-    bool saveValue = true,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<bool> onChanged,
     ValueTransformer<bool> valueTransformer,
@@ -115,7 +114,6 @@ class FormBuilderSwitch extends FormBuilderField<bool> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_text_field.dart b/lib/src/fields/form_builder_text_field.dart
@@ -295,7 +295,6 @@ class FormBuilderTextField extends FormBuilderField<String> {
     @required String name,
     FormFieldValidator<String> validator,
     String initialValue,
-    bool saveValue = true,
     bool readOnly = false,
     InputDecoration decoration = const InputDecoration(),
     ValueChanged<String> onChanged,
@@ -378,7 +377,6 @@ class FormBuilderTextField extends FormBuilderField<String> {
           validator: validator,
           valueTransformer: valueTransformer,
           onChanged: onChanged,
-          saveValue: saveValue,
           autovalidateMode: autovalidateMode,
           onSaved: onSaved,
           enabled: enabled,
diff --git a/lib/src/fields/form_builder_touch_spin.dart b/lib/src/fields/form_builder_touch_spin.dart
diff --git a/lib/src/fields/form_builder_typeahead.dart b/lib/src/fields/form_builder_typeahead.dart
diff --git a/lib/src/form_builder.dart b/lib/src/form_builder.dart
diff --git a/lib/src/form_builder_field.dart b/lib/src/form_builder_field.dart
