Added enabled attribute to FormBuilder to allow disabling the whole form

danvick · danvick · commit e048969ec617 · 2020-11-19T21:02:43.000+03:00
diff --git a/lib/src/fields/form_builder_checkbox.dart b/lib/src/fields/form_builder_checkbox.dart
@@ -112,7 +112,7 @@ class FormBuilderCheckbox extends FormBuilderField<bool> {
                 title: title,
                 subtitle: subtitle,
                 value: state.value,
-                onChanged: enabled
+                onChanged: state.enabled
                     ? (val) {
                         state.requestFocus();
                         state.didChange(val);
diff --git a/lib/src/fields/form_builder_checkbox_group.dart b/lib/src/fields/form_builder_checkbox_group.dart
@@ -84,7 +84,7 @@ class FormBuilderCheckboxGroup<T> extends FormBuilderField<List<T>> {
                   field.didChange(val);
                 },
                 disabled:
-                    enabled ? disabled : options.map((e) => e.value).toList(),
+                    state.enabled ? disabled : options.map((e) => e.value).toList(),
                 activeColor: activeColor,
                 focusColor: focusColor,
                 checkColor: checkColor,
diff --git a/lib/src/fields/form_builder_chips_input.dart b/lib/src/fields/form_builder_chips_input.dart
@@ -72,7 +72,7 @@ class FormBuilderChipsInput<T> extends FormBuilderField<List<T>> {
             return ChipsInput<T>(
               key: ObjectKey(state.value),
               initialValue: field.value,
-              enabled: enabled,
+              enabled: state.enabled,
               decoration: state.decoration(),
               findSuggestions: findSuggestions,
               onChanged: (data) {
diff --git a/lib/src/fields/form_builder_choice_chips.dart b/lib/src/fields/form_builder_choice_chips.dart
@@ -306,7 +306,7 @@ class FormBuilderChoiceChip<T> extends FormBuilderField<T> {
                       ChoiceChip(
                         label: option,
                         selected: field.value == option.value,
-                        onSelected: enabled
+                        onSelected: state.enabled
                             ? (selected) {
                                 final choice = selected ? option.value : null;
                                 state.requestFocus();
diff --git a/lib/src/fields/form_builder_color_picker.dart b/lib/src/fields/form_builder_color_picker.dart
@@ -145,7 +145,7 @@ class FormBuilderColorPickerField extends FormBuilderField<Color> {
                       },
                     ),
                   ),
-              enabled: enabled,
+              enabled: state.enabled,
               readOnly: readOnly,
               controller: state._effectiveController,
               focusNode: state.effectiveFocusNode,
@@ -209,7 +209,7 @@ class _FormBuilderColorPickerFieldState
   }
 
   Future<void> _handleFocus() async {
-    if (effectiveFocusNode.hasFocus && widget.enabled) {
+    if (effectiveFocusNode.hasFocus && enabled) {
       await Future.microtask(
           () => FocusScope.of(context).requestFocus(FocusNode()));
       final selected = await showDialog<bool>(
diff --git a/lib/src/fields/form_builder_country_picker.dart b/lib/src/fields/form_builder_country_picker.dart
diff --git a/lib/src/fields/form_builder_date_range_picker.dart b/lib/src/fields/form_builder_date_range_picker.dart
@@ -131,9 +131,9 @@ class FormBuilderDateRangePicker extends FormBuilderField<List<DateTime>> {
             final state = field as FormBuilderDateRangePickerState;
 
             return TextField(
-              enabled: enabled,
+              enabled: state.enabled,
               style: style,
-              focusNode: enabled
+              focusNode: state.enabled
                   ? state.effectiveFocusNode
                   : AlwaysDisabledFocusNode(),
               decoration: state.decoration(),
diff --git a/lib/src/fields/form_builder_date_time_picker.dart b/lib/src/fields/form_builder_date_time_picker.dart
@@ -248,7 +248,7 @@ class FormBuilderDateTimePicker extends FormBuilderField<DateTime> {
               autofocus: autofocus,
               decoration: state.decoration(),
               readOnly: true,
-              enabled: enabled,
+              enabled: state.enabled,
               autocorrect: autocorrect,
               controller: state._textFieldController,
               focusNode: state.effectiveFocusNode,
diff --git a/lib/src/fields/form_builder_dropdown.dart b/lib/src/fields/form_builder_dropdown.dart
@@ -266,7 +266,7 @@ class FormBuilderDropdown<T> extends FormBuilderField<T> {
                         iconDisabledColor: iconDisabledColor,
                         iconEnabledColor: iconEnabledColor,
                         onChanged:
-                            enabled ? (value) => changeValue(value) : null,
+                        state.enabled ? (value) => changeValue(value) : null,
                         onTap: onTap,
                         focusNode: state.effectiveFocusNode,
                         autofocus: autofocus,
@@ -277,7 +277,7 @@ class FormBuilderDropdown<T> extends FormBuilderField<T> {
                       ),
                     ),
                   ),
-                  if (allowClear && enabled && field.value != null) ...[
+                  if (allowClear && state.enabled && field.value != null) ...[
                     const VerticalDivider(),
                     InkWell(
                       child: clearIcon,
diff --git a/lib/src/fields/form_builder_file_picker.dart b/lib/src/fields/form_builder_file_picker.dart
@@ -91,7 +91,7 @@ class FormBuilderFilePicker extends FormBuilderField<List<PlatformFile>> {
                         Text('${state._files.length} / $maxFiles'),
                       InkWell(
                         child: selector,
-                        onTap: enabled &&
+                        onTap: state.enabled &&
                                 (null == state._remainingItemCount ||
                                     state._remainingItemCount > 0)
                             ? () => state.pickFiles(field)
@@ -237,7 +237,7 @@ class _FormBuilderFilePickerState
                       width: double.infinity,
                       color: Colors.white.withOpacity(.8),
                     ),
-                    if (widget.enabled)
+                    if (enabled)
                       Positioned(
                         top: 0,
                         right: 0,
diff --git a/lib/src/fields/form_builder_filter_chips.dart b/lib/src/fields/form_builder_filter_chips.dart
@@ -105,7 +105,7 @@ class FormBuilderFilterChip<T> extends FormBuilderField<List<T>> {
                     FilterChip(
                       label: option,
                       selected: field.value.contains(option.value),
-                      onSelected: enabled &&
+                      onSelected: state.enabled &&
                               (null == maxChips ||
                                   field.value.length < maxChips ||
                                   field.value.contains(option.value))
diff --git a/lib/src/fields/form_builder_image_picker.dart b/lib/src/fields/form_builder_image_picker.dart
@@ -118,7 +118,7 @@ class FormBuilderImagePicker extends FormBuilderField<List<dynamic>> {
                                       : Image.file(item as File,
                                           fit: BoxFit.cover),
                             ),
-                            if (enabled)
+                            if (state.enabled)
                               InkWell(
                                 onTap: () {
                                   state.requestFocus();
@@ -144,7 +144,7 @@ class FormBuilderImagePicker extends FormBuilderField<List<dynamic>> {
                           ],
                         );
                       }),
-                    if (enabled && !state.hasMaxImages)
+                    if (state.enabled && !state.hasMaxImages)
                       GestureDetector(
                         child: placeholderImage != null
                             ? Image(
@@ -157,11 +157,11 @@ class FormBuilderImagePicker extends FormBuilderField<List<dynamic>> {
                                 height: previewHeight,
                                 child: Icon(
                                   Icons.camera_enhance,
-                                  color: enabled
+                                  color: state.enabled
                                       ? iconColor ?? primaryColor
                                       : disabledColor,
                                 ),
-                                color: (enabled
+                                color: (state.enabled
                                         ? iconColor ?? primaryColor
                                         : disabledColor)
                                     .withAlpha(50)),
diff --git a/lib/src/fields/form_builder_phone_field.dart b/lib/src/fields/form_builder_phone_field.dart
@@ -128,7 +128,7 @@ class FormBuilderPhoneField extends FormBuilderField<String> {
               child: Row(
                 children: <Widget>[
                   GestureDetector(
-                    onTap: enabled
+                    onTap: state.enabled
                         ? () {
                             state.requestFocus();
                             if (isCupertinoPicker) {
@@ -158,7 +158,7 @@ class FormBuilderPhoneField extends FormBuilderField<String> {
                   ),
                   Expanded(
                     child: TextField(
-                      enabled: enabled,
+                      enabled: state.enabled,
                       style: style,
                       focusNode: state.effectiveFocusNode,
                       decoration: InputDecoration(
diff --git a/lib/src/fields/form_builder_radio_group.dart b/lib/src/fields/form_builder_radio_group.dart
@@ -80,8 +80,9 @@ class FormBuilderRadioGroup<T> extends FormBuilderField<T> {
                   state.requestFocus();
                   state.didChange(val);
                 },
-                disabled:
-                    enabled ? disabled : options.map((e) => e.value).toList(),
+                disabled: state.enabled
+                    ? disabled
+                    : options.map((e) => e.value).toList(),
                 activeColor: activeColor,
                 focusColor: focusColor,
                 materialTapTargetSize: materialTapTargetSize,
diff --git a/lib/src/fields/form_builder_range_slider.dart b/lib/src/fields/form_builder_range_slider.dart
@@ -165,7 +165,7 @@ class FormBuilderRangeSlider extends FormBuilderField<RangeValues> {
                         onChangeStart: onChangeStart,
                         labels: labels,
                         semanticFormatterCallback: semanticFormatterCallback,
-                        onChanged: enabled
+                        onChanged: state.enabled
                             ? (values) {
                                 state.requestFocus();
                                 field.didChange(values);
diff --git a/lib/src/fields/form_builder_rating.dart b/lib/src/fields/form_builder_rating.dart
@@ -73,7 +73,7 @@ class FormBuilderRating extends FormBuilderField<double> {
 
             return InputDecorator(
               decoration: state.decoration(),
-              child: enabled
+              child: state.enabled
                   ? RatingBar(
                       key: ObjectKey(state.value),
                       initialRating: state.value?.toDouble(),
diff --git a/lib/src/fields/form_builder_searchable_dropdown.dart b/lib/src/fields/form_builder_searchable_dropdown.dart
@@ -171,7 +171,7 @@ class FormBuilderSearchableDropdown<T> extends FormBuilderField<T> {
                 },
                 showSearchBox: showSearchBox,
                 hint: hint,
-                enabled: enabled,
+                enabled: state.enabled,
                 autoFocusSearchBox: autoFocusSearchBox,
                 autoValidateMode: autovalidateMode,
                 clearButton: clearButton,
diff --git a/lib/src/fields/form_builder_segmented_control.dart b/lib/src/fields/form_builder_segmented_control.dart
@@ -76,13 +76,13 @@ class FormBuilderSegmentedControl<T> extends FormBuilderField<T> {
               child: Padding(
                 padding: const EdgeInsets.only(top: 10.0),
                 child: CupertinoSegmentedControl<T>(
-                  borderColor: enabled
+                  borderColor: state.enabled
                       ? borderColor ?? theme.primaryColor
                       : theme.disabledColor,
-                  selectedColor: enabled
+                  selectedColor: state.enabled
                       ? selectedColor ?? theme.primaryColor
                       : theme.disabledColor,
-                  pressedColor: enabled
+                  pressedColor: state.enabled
                       ? pressedColor ?? theme.primaryColor
                       : theme.disabledColor,
                   groupValue: state.value,
@@ -97,7 +97,7 @@ class FormBuilderSegmentedControl<T> extends FormBuilderField<T> {
                   unselectedColor: unselectedColor,
                   onValueChanged: (value) {
                     state.requestFocus();
-                    if (enabled) {
+                    if (state.enabled) {
                       field.didChange(value);
                     } else {
                       field.reset();
diff --git a/lib/src/fields/form_builder_signature_pad.dart b/lib/src/fields/form_builder_signature_pad.dart
@@ -62,6 +62,7 @@ class FormBuilderSignaturePad extends FormBuilderField<Uint8List> {
             final state = field as _FormBuilderSignaturePadState;
             final theme = Theme.of(state.context);
             final localizations = MaterialLocalizations.of(state.context);
+            final cancelButtonColor = state.enabled ? theme.errorColor : theme.disabledColor;
 
             return InputDecorator(
               decoration: state.decoration(),
@@ -84,15 +85,15 @@ class FormBuilderSignaturePad extends FormBuilderField<Uint8List> {
                     children: <Widget>[
                       Expanded(child: const SizedBox()),
                       TextButton.icon(
-                        onPressed: () {
+                        onPressed: state.enabled ? () {
                           state._controller.clear();
                           field.didChange(null);
-                        },
+                        } : null,
                         label: Text(
                           clearButtonText ?? localizations.cancelButtonLabel,
-                          style: TextStyle(color: theme.errorColor),
+                          style: TextStyle(color: cancelButtonColor),
                         ),
-                        icon: Icon(Icons.clear, color: theme.errorColor),
+                        icon: Icon(Icons.clear, color: cancelButtonColor),
                       ),
                     ],
                   ),
diff --git a/lib/src/fields/form_builder_slider.dart b/lib/src/fields/form_builder_slider.dart
@@ -190,7 +190,7 @@ class FormBuilderSlider extends FormBuilderField<double> {
                       onChangeStart: onChangeStart,
                       label: label,
                       semanticFormatterCallback: semanticFormatterCallback,
-                      onChanged: enabled
+                      onChanged: state.enabled
                           ? (value) {
                               state.requestFocus();
                               field.didChange(value);
diff --git a/lib/src/fields/form_builder_switch.dart b/lib/src/fields/form_builder_switch.dart
@@ -130,7 +130,7 @@ class FormBuilderSwitch extends FormBuilderField<bool> {
                 contentPadding: contentPadding,
                 title: title,
                 value: state.value,
-                onChanged: enabled
+                onChanged: state.enabled
                     ? (val) {
                         state.requestFocus();
                         field.didChange(val);
diff --git a/lib/src/fields/form_builder_text_field.dart b/lib/src/fields/form_builder_text_field.dart
@@ -422,7 +422,7 @@ class FormBuilderTextField extends FormBuilderField<String> {
               onEditingComplete: onEditingComplete,
               onSubmitted: onSubmitted,
               inputFormatters: inputFormatters,
-              enabled: enabled,
+              enabled: state.enabled,
               cursorWidth: cursorWidth,
               cursorRadius: cursorRadius,
               cursorColor: cursorColor,
diff --git a/lib/src/fields/form_builder_touch_spin.dart b/lib/src/fields/form_builder_touch_spin.dart
@@ -93,7 +93,7 @@ class FormBuilderTouchSpin extends FormBuilderField<num> {
                 step: step,
                 value: field.value,
                 iconSize: iconSize,
-                onChanged: enabled
+                onChanged: state.enabled
                     ? (value) {
                         state.requestFocus();
                         state.didChange(value);
@@ -106,7 +106,7 @@ class FormBuilderTouchSpin extends FormBuilderField<num> {
                 iconActiveColor: iconActiveColor ?? theme.primaryColor,
                 iconDisabledColor: iconDisabledColor ?? theme.disabledColor,
                 iconPadding: iconPadding,
-                enabled: enabled,
+                enabled: state.enabled,
               ),
             );
           },
diff --git a/lib/src/fields/form_builder_typeahead.dart b/lib/src/fields/form_builder_typeahead.dart
@@ -314,9 +314,9 @@ class FormBuilderTypeAhead<T> extends FormBuilderField<T> {
 
             return TypeAheadField<T>(
               textFieldConfiguration: textFieldConfiguration.copyWith(
-                enabled: enabled,
+                enabled: state.enabled,
                 controller: state._typeAheadController,
-                style: enabled
+                style: state.enabled
                     ? textFieldConfiguration.style
                     : theme.textTheme.subtitle1.copyWith(
                         color: theme.disabledColor,
diff --git a/lib/src/form_builder.dart b/lib/src/form_builder.dart
@@ -51,6 +51,14 @@ class FormBuilder extends StatefulWidget {
   /// Default is `false`.
   final bool skipDisabled;
 
+  /// Whether the form is able to receive user input.
+  ///
+  /// Defaults to true.
+  ///
+  /// When `false` all the form fields will be disabled - won't accept input -
+  /// and their enabled state will be ignored.
+  final bool enabled;
+
   const FormBuilder({
     Key key,
     @required this.child,
@@ -59,6 +67,7 @@ class FormBuilder extends StatefulWidget {
     this.onWillPop,
     this.initialValue = const <String, dynamic>{},
     this.skipDisabled = false,
+    this.enabled = true,
   }) : super(key: key);
 
   static FormBuilderState of(BuildContext context) =>
@@ -71,6 +80,8 @@ class FormBuilder extends StatefulWidget {
 class FormBuilderState extends State<FormBuilder> {
   final _formKey = GlobalKey<FormState>();
 
+  bool get enabled => widget.enabled;
+
   final _fields = <String, FormBuilderFieldState>{};
 
   final _value = <String, dynamic>{};
diff --git a/lib/src/form_builder_field.dart b/lib/src/form_builder_field.dart
@@ -97,6 +97,8 @@ abstract class FormBuilderFieldState<F extends FormBuilderField<T>, T>
 
   bool _touched = false;
 
+  bool get enabled =>  _formBuilderState?.enabled == false ? false : widget.enabled;
+
   FocusNode _focusNode;
 
   FocusNode get effectiveFocusNode => _focusNode;
@@ -129,7 +131,7 @@ abstract class FormBuilderFieldState<F extends FormBuilderField<T>, T>
   void save() {
     super.save();
     if (_formBuilderState != null) {
-      if (widget.enabled || !_formBuilderState.widget.skipDisabled) {
+      if (enabled || !_formBuilderState.widget.skipDisabled) {
         _formBuilderState.setInternalFieldValue(
           widget.name,
           null != widget.valueTransformer
