Add itemDecoration to checkbox groups nad radio groups

freemansoft · freemansoft · commit c94ec60417d5 · 2023-12-23T17:53:14.000-05:00
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -1,4 +1,5 @@
 import 'package:example/sources/conditional_fields.dart';
+import 'package:example/sources/decorated_radio_checkbox.dart';
 import 'package:example/sources/dynamic_fields.dart';
 import 'package:example/sources/related_fields.dart';
 import 'package:flutter/material.dart';
@@ -141,6 +142,23 @@ class _HomePage extends StatelessWidget {
               );
             },
           ),
+          const Divider(),
+          ListTile(
+            title: const Text('Radio Checkbox itemDecorator'),
+            trailing: const Icon(Icons.arrow_right_sharp),
+            onTap: () {
+              Navigator.of(context).push(
+                MaterialPageRoute(
+                  builder: (context) {
+                    return const CodePage(
+                      title: 'ItemDecorators',
+                      child: DecoratedRadioCheckbox(),
+                    );
+                  },
+                ),
+              );
+            },
+          ),
         ],
       ),
     );
diff --git a/example/lib/sources/decorated_radio_checkbox.dart b/example/lib/sources/decorated_radio_checkbox.dart
@@ -0,0 +1,101 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_form_builder/flutter_form_builder.dart';
+
+class DecoratedRadioCheckbox extends StatefulWidget {
+  const DecoratedRadioCheckbox({Key? key}) : super(key: key);
+
+  @override
+  State<DecoratedRadioCheckbox> createState() => _DecoratedRadioCheckboxState();
+}
+
+class _DecoratedRadioCheckboxState extends State<DecoratedRadioCheckbox> {
+  final _formKey = GlobalKey<FormBuilderState>();
+  int? option;
+
+  @override
+  Widget build(BuildContext context) {
+    return FormBuilder(
+      key: _formKey,
+      child: Column(
+        children: <Widget>[
+          const SizedBox(height: 20),
+          FormBuilderCheckboxGroup(
+            name: 'aCheckboxGroup',
+            options: getDemoOptionsWidgets(),
+            wrapSpacing: 5.0,
+            itemDecoration: BoxDecoration(
+                border: Border.all(color: Colors.blueAccent),
+                borderRadius: BorderRadius.circular(5.0)),
+          ),
+          const SizedBox(height: 20),
+          FormBuilderCheckboxGroup(
+            name: 'aCheckboxGroup',
+            options: getDemoOptionsWidgets(),
+            wrapSpacing: 5.0,
+            controlAffinity: ControlAffinity.trailing,
+            itemDecoration: BoxDecoration(
+                border: Border.all(color: Colors.blueAccent),
+                borderRadius: BorderRadius.circular(5.0)),
+          ),
+          const SizedBox(height: 20),
+          FormBuilderRadioGroup(
+            name: 'aRadioGroup',
+            options: getDemoOptionsWidgets(),
+            wrapSpacing: 5.0,
+            itemDecoration: BoxDecoration(
+                border: Border.all(color: Colors.blueAccent),
+                borderRadius: BorderRadius.circular(5.0)),
+          ),
+          const SizedBox(height: 20),
+          FormBuilderRadioGroup(
+            name: 'aRadioGroup2',
+            options: getDemoOptions(),
+            wrapSpacing: 5.0,
+            itemDecoration: BoxDecoration(
+                border: Border.all(color: Colors.blueAccent),
+                borderRadius: BorderRadius.circular(5.0)),
+          ),
+          const SizedBox(height: 20),
+        ],
+      ),
+    );
+  }
+
+  List<FormBuilderFieldOption> getDemoOptionsWidgets() {
+    return const [
+      FormBuilderFieldOption(
+          value: "airplane",
+          child: Column(
+            children: [Text("Airplane"), Icon(Icons.airplanemode_on)],
+          )),
+      FormBuilderFieldOption(
+          value: "fire-truck",
+          child:
+              Column(children: [Text("Fire Truck"), Icon(Icons.fire_truck)])),
+      FormBuilderFieldOption(
+          value: "bus-alert",
+          child: Column(children: [Text("Bus Alert"), Icon(Icons.bus_alert)])),
+      FormBuilderFieldOption(
+          value: "firetruck",
+          child:
+              Column(children: [Text("Motorcycle"), Icon(Icons.motorcycle)])),
+    ];
+  }
+
+  List<FormBuilderFieldOption> getDemoOptions() {
+    return const [
+      FormBuilderFieldOption(
+        value: "airplane",
+      ),
+      FormBuilderFieldOption(
+        value: "fire-truck",
+      ),
+      FormBuilderFieldOption(
+        value: "bus-alert",
+      ),
+      FormBuilderFieldOption(
+        value: "firetruck",
+      ),
+    ];
+  }
+}
diff --git a/lib/src/fields/form_builder_checkbox_group.dart b/lib/src/fields/form_builder_checkbox_group.dart
@@ -25,6 +25,9 @@ class FormBuilderCheckboxGroup<T> extends FormBuilderFieldDecoration<List<T>> {
   final ControlAffinity controlAffinity;
   final OptionsOrientation orientation;
 
+  /// A decorator that is applied to each select item - ex: box the item
+  final BoxDecoration? itemDecoration;
+
   /// Creates a list of Checkboxes for selecting multiple options
   FormBuilderCheckboxGroup({
     super.key,
@@ -60,6 +63,7 @@ class FormBuilderCheckboxGroup<T> extends FormBuilderFieldDecoration<List<T>> {
     this.separator,
     this.controlAffinity = ControlAffinity.leading,
     this.orientation = OptionsOrientation.wrap,
+    this.itemDecoration,
   }) : super(
           builder: (FormFieldState<List<T>?> field) {
             final state = field as _FormBuilderCheckboxGroupState<T>;
@@ -93,6 +97,7 @@ class FormBuilderCheckboxGroup<T> extends FormBuilderFieldDecoration<List<T>> {
                 wrapVerticalDirection: wrapVerticalDirection,
                 separator: separator,
                 controlAffinity: controlAffinity,
+                itemDecoration: itemDecoration,
               ),
             );
           },
diff --git a/lib/src/fields/form_builder_radio_group.dart b/lib/src/fields/form_builder_radio_group.dart
@@ -22,6 +22,9 @@ class FormBuilderRadioGroup<T> extends FormBuilderFieldDecoration<T> {
   final WrapAlignment wrapRunAlignment;
   final WrapCrossAlignment wrapCrossAxisAlignment;
 
+  /// A decorator that is applied to each select item - ex: box the item
+  final BoxDecoration? itemDecoration;
+
   /// Creates field to select one value from a list of Radio Widgets
   FormBuilderRadioGroup({
     super.autovalidateMode = AutovalidateMode.disabled,
@@ -54,6 +57,7 @@ class FormBuilderRadioGroup<T> extends FormBuilderFieldDecoration<T> {
     super.valueTransformer,
     super.onReset,
     super.restorationId,
+    this.itemDecoration,
   }) : super(
           builder: (FormFieldState<T?> field) {
             final state = field as _FormBuilderRadioGroupState<T>;
@@ -84,6 +88,7 @@ class FormBuilderRadioGroup<T> extends FormBuilderFieldDecoration<T> {
                 wrapSpacing: wrapSpacing,
                 wrapTextDirection: wrapTextDirection,
                 wrapVerticalDirection: wrapVerticalDirection,
+                itemDecoration: itemDecoration,
               ),
             );
           },
diff --git a/lib/src/widgets/grouped_checkbox.dart b/lib/src/widgets/grouped_checkbox.dart
@@ -181,6 +181,9 @@ class GroupedCheckbox<T> extends StatelessWidget {
 
   final ControlAffinity controlAffinity;
 
+  /// will be added to each item if provided
+  final BoxDecoration? itemDecoration;
+
   const GroupedCheckbox({
     super.key,
     required this.options,
@@ -205,13 +208,14 @@ class GroupedCheckbox<T> extends StatelessWidget {
     this.separator,
     this.controlAffinity = ControlAffinity.leading,
     this.visualDensity,
+    this.itemDecoration,
   });
 
   @override
   Widget build(BuildContext context) {
     final widgetList = <Widget>[];
     for (var i = 0; i < options.length; i++) {
-      widgetList.add(item(i));
+      widgetList.add(buildItem(i));
     }
     Widget finalWidget;
     if (orientation == OptionsOrientation.vertical) {
@@ -249,7 +253,8 @@ class GroupedCheckbox<T> extends StatelessWidget {
     return finalWidget;
   }
 
-  Widget item(int index) {
+  /// the composite of all the components for the option at index
+  Widget buildItem(int index) {
     final option = options[index];
     final optionValue = option.value;
     final isOptionDisabled = true == disabled?.contains(optionValue);
@@ -287,7 +292,7 @@ class GroupedCheckbox<T> extends StatelessWidget {
       child: option,
     );
 
-    return Row(
+    Widget compositeItem = Row(
       mainAxisSize: MainAxisSize.min,
       children: <Widget>[
         if (controlAffinity == ControlAffinity.leading) control,
@@ -296,5 +301,14 @@ class GroupedCheckbox<T> extends StatelessWidget {
         if (separator != null && index != options.length - 1) separator!,
       ],
     );
+
+    if (this.itemDecoration != null) {
+      compositeItem = Container(
+        decoration: this.itemDecoration,
+        child: compositeItem,
+      );
+    }
+
+    return compositeItem;
   }
 }
diff --git a/lib/src/widgets/grouped_radio.dart b/lib/src/widgets/grouped_radio.dart
@@ -172,6 +172,9 @@ class GroupedRadio<T> extends StatefulWidget {
 
   final ControlAffinity controlAffinity;
 
+  /// will be added to each item if provided
+  final BoxDecoration? itemDecoration;
+
   const GroupedRadio({
     super.key,
     required this.options,
@@ -193,6 +196,7 @@ class GroupedRadio<T> extends StatefulWidget {
     this.wrapVerticalDirection = VerticalDirection.down,
     this.separator,
     this.controlAffinity = ControlAffinity.leading,
+    this.itemDecoration,
   });
 
   @override
@@ -204,7 +208,7 @@ class _GroupedRadioState<T> extends State<GroupedRadio<T?>> {
   Widget build(BuildContext context) {
     final widgetList = <Widget>[];
     for (int i = 0; i < widget.options.length; i++) {
-      widgetList.add(_buildRadioButton(i));
+      widgetList.add(buildItem(i));
     }
 
     switch (widget.orientation) {
@@ -239,7 +243,8 @@ class _GroupedRadioState<T> extends State<GroupedRadio<T?>> {
     }
   }
 
-  Widget _buildRadioButton(int index) {
+  /// the composite of all the components for the option at index
+  Widget buildItem(int index) {
     final option = widget.options[index];
     final optionValue = option.value;
     final isOptionDisabled = true == widget.disabled?.contains(optionValue);
@@ -266,7 +271,7 @@ class _GroupedRadioState<T> extends State<GroupedRadio<T?>> {
       child: option,
     );
 
-    return Column(
+    Widget compositeItem = Column(
       mainAxisSize: MainAxisSize.min,
       crossAxisAlignment: CrossAxisAlignment.start,
       children: [
@@ -288,5 +293,14 @@ class _GroupedRadioState<T> extends State<GroupedRadio<T?>> {
           widget.separator!,
       ],
     );
+
+    if (widget.itemDecoration != null) {
+      compositeItem = Container(
+        decoration: widget.itemDecoration,
+        child: compositeItem,
+      );
+    }
+
+    return compositeItem;
   }
 }
diff --git a/test/form_builder_checkbox_group_test.dart b/test/form_builder_checkbox_group_test.dart
@@ -28,6 +28,27 @@ void main() {
     expect(formSave(), isTrue);
     expect(formValue(widgetName), equals(const [1, 3]));
   });
+
+  testWidgets('FormBuilderCheckboxGroup -- decoration',
+      (WidgetTester tester) async {
+    const widgetName = 'cbg1';
+    final testWidget = FormBuilderCheckboxGroup<int>(
+      name: widgetName,
+      options: const [
+        FormBuilderFieldOption(key: ValueKey('1'), value: 1),
+        FormBuilderFieldOption(key: ValueKey('2'), value: 2),
+        FormBuilderFieldOption(key: ValueKey('3'), value: 3),
+      ],
+      itemDecoration:
+          BoxDecoration(border: Border.all(color: Colors.blueAccent)),
+    );
+    await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+
+    // this is a brittle test knowing how we use container for a border
+    // there is one container for each option
+    expect(find.byType(Container), findsExactly(3));
+  });
+
   testWidgets('FormBuilderCheckboxGroup -- didChange',
       (WidgetTester tester) async {
     const fieldName = 'cbg1';
diff --git a/test/form_builder_radio_group_test.dart b/test/form_builder_radio_group_test.dart
@@ -27,4 +27,24 @@ void main() {
     expect(formSave(), isTrue);
     expect(formValue(widgetName), equals(3));
   });
+
+  testWidgets('FormBuilderRadioGroup -- decoration',
+      (WidgetTester tester) async {
+    const widgetName = 'rg1';
+    final testWidget = FormBuilderRadioGroup<int>(
+      name: widgetName,
+      options: const [
+        FormBuilderFieldOption(key: ValueKey('1'), value: 1),
+        FormBuilderFieldOption(key: ValueKey('2'), value: 2),
+        FormBuilderFieldOption(key: ValueKey('3'), value: 3),
+      ],
+      itemDecoration:
+          BoxDecoration(border: Border.all(color: Colors.blueAccent)),
+    );
+    await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+
+    // this is a brittle test knowing how we use container for a border
+    // there is one container for each option
+    expect(find.byType(Container), findsExactly(3));
+  });
 }
