feat: #1311 add allowClear and clearIcon to FormBuilderDateTimePicker

[majumdersubhanu]

Connection with issue(s)

Close #1311

Solution description

Added allowClear property to FormBuilderDateTimePicker also builds upon the default input decoration.

@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;

To use the new property

FormBuilderDateTimePicker(
  name: 'date',
  initialEntryMode: DatePickerEntryMode.calendar,
  initialValue: DateTime.now(),
  inputType: InputType.both,
  decoration: InputDecoration(
    labelText: 'Appointment Time',
    // 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,
  // TODO: use any icon of choice or default one
  clearIcon: Icon(Icons.clear),
)

Screenshots or Videos

As you can see the x icon doesn't appear when the field is empty

The x icon appears ONLY when date and time are both selected, and also not selecting time leads to empty value in the field

To Do

• Read contributing guide
• Check the original issue to confirm it is fully satisfied
• Add solution description to help guide reviewers
• Add unit test to verify new or fixed behaviour
• If apply, add documentation to code properties and package readme

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.40%. Comparing base (bff073a) to head (9e160ad).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1505      +/-   ##
==========================================
+ Coverage   91.06%   91.40%   +0.33%     
==========================================
  Files          21       21              
  Lines         851      861      +10     
==========================================
+ Hits          775      787      +12     
+ Misses         76       74       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[majumdersubhanu]

Full disclosure this is my first OSS contribution ever, and feedback is greatly appreciated.

[deandreamatias]

Sorry but this isn't a priority right now. See details on #1293