Merge pull request #47 from udos86/15.0.0

v15.0.0

Author: udos86

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
     - uses: actions/checkout@v3
     - uses: subosito/flutter-action@v2
       with:
-        flutter-version: '3.16.4'
+        flutter-version: '3.16.5'
         channel: 'stable'
 
     - name: Install Dependencies

CHANGELOG.md

@@ -1,9 +1,12 @@
-## [15.0.0] - 01/xx/2024
+## [15.0.0] - 01/08/2024
 
 * upgrades to Flutter `3.16.5`
 * adds new feature **Conditional Form Fields**
   * adds `conditions` property to `FastFormField`
-  * adds `FastCondition` class
+  * adds `FastCondition`, `FastConditionList` classes
+  * adds `FastConditionMatch` enum
+  * adds `FastConditionHandler` and `FastConditionTest` typedefs
+  * adds `testConditions` function to `FastformFieldState`
 * adds new `FastSegmentendButton` that wraps Material [`SegmentedButton`](https://api.flutter.dev/flutter/material/SegmentedButton-class.html?gclid=CjwKCAiAs6-sBhBmEiwA1Nl8s5c8wRhB056CtAeuZP1-m_XUYi-jYGrVMh1lMnkwRmvKwlTelErtixoCAS4QAvD_BwE&gclsrc=aw.ds)
 * adds `showInputDecoration` property to `FastCheckbox`, `FastSwitch`, `FastCalendar`, `FastChoiceChips`, `FastRadioGroup`, `FastRangeSlider` and `FastSlider`
 * adds `canPop` and `onPopInvoked` properties to `FastForm`
@@ -19,6 +22,7 @@
 * replaces `FastSliderPrefixBuilder` and `FastSliderSuffixBuilder` with `FastSliderWidgetBuilder` typedef
 * adds `FastDatePickerWidgetBuilder` typedef
 * fixes generic typing in `FastChoiceChips` and `FastSegmentedControl`
+* fixes hard-coded text colors in `checkboxTitleBuilder` and `switchTitleBuilder`
 
 ## [14.1.0] - 12/18/2023
 

README.md

@@ -233,13 +233,14 @@ class FormPage extends StatelessWidget {
               ),
             ],
             conditions: {
-              FastCondition.disabled: [
+              FastCondition.disabled: FastConditionList([
                 FastCondition(
-                    fieldName: 'segmented_button',
-                    condition: (value, field) {
-                      return value is Set<String> && value.isNotEmpty;
-                    }),
-              ]
+                  target: 'segmented_button',
+                  test: (value, field) {
+                    return value is Set<String> && value.isNotEmpty;
+                  },
+                ),
+              ]),
             },
             validator: (value) => value == null || value.isEmpty
                 ? 'Please select at least one chip'
@@ -260,13 +261,15 @@ class FormPage extends StatelessWidget {
             prefix: const Icon(Icons.calendar_today),
             buildCounter: inputCounterWidgetBuilder,
             inputFormatters: const [],
-            validator: Validators.compose([
-              Validators.required((value) => 'Field is required'),
-              Validators.minLength(
-                  7,
-                  (value, minLength) =>
-                      'Field must contain at least $minLength characters')
-            ]),
+            validator: Validators.compose(
+              [
+                Validators.required((value) => 'Field is required'),
+                Validators.minLength(
+                    7,
+                    (value, minLength) =>
+                        'Field must contain at least $minLength characters')
+              ],
+            ),
           ),
           const FastDropdown(
             name: 'dropdown',

example/lib/main.dart

@@ -145,12 +145,14 @@ Widget? checkboxPrefixBuilder(FastCheckboxState field) {
 Widget? checkboxTitleBuilder(FastCheckboxState field) {
   final FastCheckboxState(:value!) = field;
   final FastCheckbox(:titleText) = field.widget;
+  final theme = Theme.of(field.context);
+  final color = theme.textTheme.titleMedium?.color ?? Colors.black;
 
   if (titleText is String) {
     return Text(
       titleText,
       style: TextStyle(
-        color: value ? Colors.black : Colors.grey,
+        color: value ? color : theme.disabledColor,
       ),
     );
   }

lib/src/check/checkbox.dart

@@ -157,12 +157,14 @@ Widget? switchPrefixBuilder(FastSwitchState field) {
 Widget? switchTitleBuilder(FastSwitchState field) {
   final FastSwitchState(:value!, :widget) = field;
   final FastSwitch(:titleText) = widget;
+  final theme = Theme.of(field.context);
+  final color = theme.textTheme.titleMedium?.color ?? Colors.black;
 
   if (titleText is String) {
     return Text(
       titleText,
       style: TextStyle(
-        color: value ? Colors.black : Colors.grey,
+        color: value ? color : theme.disabledColor,
       ),
     );
   }

lib/src/check/switch.dart

@@ -77,7 +77,7 @@ class FastFormState extends State<FastForm> {
   void onChanged() {
     widget.onChanged?.call(values);
     for (final field in _fields.values) {
-      field.condition();
+      field.testConditions();
     }
   }
 
@@ -115,30 +115,76 @@ class _FastFormScope extends InheritedWidget {
   bool updateShouldNotify(InheritedWidget oldWidget) => true;
 }
 
+/// A [Function] that tests whether a single [FastCondition] is met.
+typedef FastConditionTest = bool Function(
+    dynamic value, FastFormFieldState field);
+
+/// A [Function] that defines a conditional state of a [FastFormField].
+///
+/// Implements, what happens when a condition is met or not.
+///
+/// Typically linked to [FastConditionList].
+///
+/// Called at the end of every [FastFormFieldState.testConditions] run.
 typedef FastConditionHandler = void Function(
     bool isMet, FastFormFieldState field);
 
+/// A single condition to be met for a conditional state to occur.
 @immutable
 class FastCondition {
   const FastCondition({
-    required this.fieldName,
-    this.required = false,
-    required this.condition,
+    required this.target,
+    required this.test,
   });
 
-  final String fieldName;
-  final bool required;
-  final bool Function(dynamic value, FastFormFieldState field) condition;
+  /// The name of the [FastFormField] this [test] should be called upon.
+  final String target;
+
+  final FastConditionTest test;
 
+  /// A [FastConditionHandler] that disables a [FastFormField] based
+  /// on whether a [FastCondition] is met.
   static void disabled(bool isMet, FastFormFieldState field) {
     field.enabled = !isMet;
   }
 
+  /// A [FastConditionHandler] that enables a [FastFormField] based
+  /// on whether a [FastCondition] is met.
   static void enabled(bool isMet, FastFormFieldState field) {
     field.enabled = isMet;
   }
 }
 
+/// An enum to define a match logic for a [List] of multiple [FastCondition]
+/// elements.
+///
+/// Typically specifies how all individual [FastCondition.test] results in a
+/// [FastConditionList] are evaluated to determine whether a condition in
+/// [FastFormField.conditions] is met.
+enum FastConditionMatch {
+  /// Every [FastCondition.test] in a [FastConditionList] must be true to met
+  /// the condition.
+  every,
+
+  /// At least one [FastCondition.test] in a [FastConditionList] must be true to
+  /// met the condition.
+  any,
+}
+
+/// A wrapper class for a [List] of [FastCondition] elements.
+@immutable
+class FastConditionList {
+  const FastConditionList(
+    this.conditions, {
+    this.match = FastConditionMatch.any,
+  });
+
+  final List<FastCondition> conditions;
+
+  /// Defaults to [FastConditionMatch.any].
+  final FastConditionMatch match;
+}
+
 /// A single fast form field.
 ///
 /// Works identical to built-in [FormField].
@@ -169,7 +215,7 @@ abstract class FastFormField<T> extends FormField<T> {
 
   /// null represents a non-adaptive form field widget
   final bool? adaptive;
-  final Map<FastConditionHandler, List<FastCondition>>? conditions;
+  final Map<FastConditionHandler, FastConditionList>? conditions;
   final EdgeInsetsGeometry? contentPadding;
   final InputDecoration? decoration;
   final String? helperText;
@@ -304,39 +350,40 @@ abstract class FastFormFieldState<T> extends FormFieldState<T> {
     });
   }
 
-  void condition() {
+  /// Determines for every [MapEntry] in [FastFormField.conditions] if the
+  /// respective condition is met.
+  ///
+  /// Finally calls the corresponding [FastConditionHandler], passing the
+  /// result of the condition matching.
+  void testConditions() {
     final FastFormField<T>(:conditions) = widget;
     if (conditions == null || conditions.isEmpty) return;
 
-    final Map<FastConditionHandler, bool> map = {};
-
-    for (final MapEntry(key: handler, :value) in conditions.entries) {
-      map[handler] = false;
+    for (final MapEntry(key: handler, value: list) in conditions.entries) {
+      final FastConditionList(:conditions, match: logic) = list;
+      final bool isMet;
 
-      for (final FastCondition(:condition, :fieldName, :required) in value) {
-        final field = form?.getFieldByName(fieldName);
-        if (field == null) continue;
+      test(condition) => _testCondition(condition);
 
-        final isMet = condition(field.value, field);
-
-        if (isMet && required) {
-          map.update(handler, (value) => true);
-        } else if (isMet && !required) {
-          map.update(handler, (value) => true);
-        } else if (!isMet && required) {
-          map.update(handler, (value) => false);
-          break;
-        } else if (!isMet && !required) {
-          map.update(handler, (value) => value || false);
-        }
+      switch (logic) {
+        case FastConditionMatch.any:
+          isMet = conditions.any(test);
+        case FastConditionMatch.every:
+          isMet = conditions.every(test);
       }
-    }
 
-    for (final MapEntry(key: handler, value: isMet) in map.entries) {
       handler(isMet, this);
     }
   }
 
+  bool _testCondition(FastCondition condition) {
+    final FastCondition(:target, :test) = condition;
+    final field = form?.getFieldByName(target);
+    if (field == null) throw ArgumentError('Target $target is null.');
+
+    return test(field.value, field);
+  }
+
   void _onFocusChanged() {
     setState(() {
       if (focusNode.hasFocus) {

lib/src/form.dart

@@ -1,6 +1,6 @@
 name: flutter_fast_forms
-description: Flutter Fast Forms is the only Dart package you'll ever need to build Flutter forms fast.
-version: 14.1.0
+description: Flutter Fast Forms is the only Dart package you need to build Flutter forms fast.
+version: 15.0.0
 repository: https://github.com/udos86/flutter-fast-forms
 
 environment:

pubspec.yaml

@@ -8,7 +8,6 @@ void main() {
   late FastSwitch fastSwitch;
   late FastCondition checkboxCondition;
   late FastCondition switchCondition;
-  late FastCondition switchRequiredCondition;
 
   const Map<FastConditionHandler, bool> cases = {
     FastCondition.disabled: false,
@@ -27,19 +26,13 @@ void main() {
     );
 
     checkboxCondition = FastCondition(
-      fieldName: 'checkbox',
-      condition: (value, field) => value is bool && value,
+      target: 'checkbox',
+      test: (value, field) => value is bool && value,
     );
 
     switchCondition = FastCondition(
-      fieldName: 'switch',
-      condition: (value, field) => value is bool && value,
-    );
-
-    switchRequiredCondition = FastCondition(
-      fieldName: 'switch',
-      required: true,
-      condition: (value, field) => value is bool && value,
+      target: 'switch',
+      test: (value, field) => value is bool && value,
     );
   });
 
@@ -53,7 +46,7 @@ void main() {
           enabled: !enabled,
           name: 'text_field',
           conditions: {
-            handler: [switchCondition],
+            handler: FastConditionList([switchCondition]),
           },
         ),
       ]));
@@ -77,7 +70,7 @@ void main() {
           enabled: !enabled,
           name: 'text_field',
           conditions: {
-            handler: [checkboxCondition, switchCondition],
+            handler: FastConditionList([checkboxCondition, switchCondition]),
           },
         ),
       ]));
@@ -108,7 +101,10 @@ void main() {
           enabled: !enabled,
           name: 'text_field',
           conditions: {
-            handler: [checkboxCondition, switchRequiredCondition],
+            handler: FastConditionList(
+              [checkboxCondition, switchCondition],
+              match: FastConditionMatch.every,
+            ),
           },
         ),
       ]));