feat: add allowClear and clearIcon to FormBuilderDateTimePicker

Author: majumdersubhanu

example/lib/sources/complete_form.dart

@@ -55,15 +55,17 @@ class _CompleteFormState extends State<CompleteForm> {
                   inputType: InputType.both,
                   decoration: InputDecoration(
                     labelText: 'Appointment Time',
-                    suffixIcon: IconButton(
-                      icon: const Icon(Icons.close),
-                      onPressed: () {
-                        _formKey.currentState!.fields['date']?.didChange(null);
-                      },
-                    ),
+                    // TODO: use allowClear property to automatically perform this action.
+                    // suffixIcon: IconButton(
+                    //   icon: const Icon(Icons.close),
+                    //   onPressed: () {
+                    //     _formKey.currentState!.fields['date']?.didChange(null);
+                    //   },
+                    // ),
                   ),
                   initialTime: const TimeOfDay(hour: 8, minute: 0),
                   // locale: const Locale.fromSubtags(languageCode: 'fr'),
+                  allowClear: true,
                 ),
                 FormBuilderDateRangePicker(
                   name: 'date_range',

example/pubspec.lock

@@ -60,7 +60,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "10.3.0+1"
+    version: "10.3.0+2"
   flutter_lints:
     dependency: "direct dev"
     description:
@@ -131,10 +131,10 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: "12956d0ad8390bbcc63ca2e1469c0619946ccb52809807067a7020d57e647aa6"
+      sha256: dc0b7dc7651697ea4ff3e69ef44b0407ea32c487a39fff6a4004fa585e901861
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.18"
+    version: "0.12.19"
   material_color_utilities:
     dependency: transitive
     description:
@@ -208,10 +208,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: "93167629bfc610f71560ab9312acdda4959de4df6fac7492c89ff0d3886f6636"
+      sha256: "8161c84903fd860b26bfdefb7963b3f0b68fee7adea0f59ef805ecca346f0c7a"
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.9"
+    version: "0.7.10"
   vector_math:
     dependency: transitive
     description:

lib/src/fields/form_builder_date_time_picker.dart

@@ -2,10 +2,8 @@ import 'dart:ui' as ui;
 
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
-
-import 'package:intl/intl.dart';
-
 import 'package:flutter_form_builder/flutter_form_builder.dart';
+import 'package:intl/intl.dart';
 
 enum InputType { date, time, both }
 
@@ -123,6 +121,9 @@ class FormBuilderDateTimePicker extends FormBuilderFieldDecoration<DateTime> {
   final EntryModeChangeCallback? onEntryModeChanged;
   final bool barrierDismissible;
 
+  final bool allowClear;
+  final Widget? clearIcon;
+
   /// If true, disables the picker so it's not shown when the field is tapped.
   final bool disablePicker;
 
@@ -197,6 +198,9 @@ class FormBuilderDateTimePicker extends FormBuilderFieldDecoration<DateTime> {
     this.onEntryModeChanged,
     this.disablePicker = false,
     this.barrierDismissible = true,
+    // TODO: set allClear to true if that's the default behaviour
+    this.allowClear = false,
+    this.clearIcon,
   }) : super(
          builder: (FormFieldState<DateTime?> field) {
            final state = field as _FormBuilderDateTimePickerState;
@@ -404,6 +408,27 @@ class _FormBuilderDateTimePickerState
   DateTime? convert(TimeOfDay? time) =>
       time == null ? null : DateTime(1, 1, 1, time.hour, time.minute);
 
+  /// Sets the [allowClear] property for automatic DateTime reset, and [clearIcon] to a default or user defined icon.
+  @override
+  InputDecoration get decoration => widget.allowClear
+      ? super.decoration.copyWith(
+          suffix: value == null
+              ? null
+              : IconButton(
+                  padding: EdgeInsets.zero,
+                  constraints: const BoxConstraints(
+                    maxWidth: 24,
+                    maxHeight: 24,
+                  ),
+                  onPressed: () {
+                    focus();
+                    didChange(null);
+                  },
+                  icon: widget.clearIcon ?? const Icon(Icons.clear),
+                ),
+        )
+      : super.decoration;
+
   @override
   void didChange(DateTime? value) {
     super.didChange(value);

pubspec.lock

@@ -111,10 +111,10 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: "12956d0ad8390bbcc63ca2e1469c0619946ccb52809807067a7020d57e647aa6"
+      sha256: dc0b7dc7651697ea4ff3e69ef44b0407ea32c487a39fff6a4004fa585e901861
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.18"
+    version: "0.12.19"
   material_color_utilities:
     dependency: transitive
     description:
@@ -188,10 +188,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: "93167629bfc610f71560ab9312acdda4959de4df6fac7492c89ff0d3886f6636"
+      sha256: "8161c84903fd860b26bfdefb7963b3f0b68fee7adea0f59ef805ecca346f0c7a"
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.9"
+    version: "0.7.10"
   vector_math:
     dependency: transitive
     description: