FormBuilderFields Type Alias

[erayerdin]

Solution description

In most cases, the type is inferred when FormBuilderState.fields is assigned to a variable. An example:

// the type is inferred.
final fields = _formKey.currentState?.fields;

However, when the dev needs to pass the reference of fields to a function, closure definition, constructor etc., they have to explicitly define its type. Currently, the type for FormBuilderState.fields is Map<String, FormBuilderFieldState<FormBuilderField<dynamic>, dynamic>>. So, consider the simple function (which might also be taken as an event definition in BLoC) which needs to take fields as input:

void logIn({required Map<String, FormBuilderFieldState<FormBuilderField<dynamic>, dynamic>> fields}) {
  // or Map<String, FormBuilderFieldState<FormBuilderField, dynamic>>
  // assuming fields have `email` and `password` fields...
  // ...which will be used to log in using Firebase
}

So, instead of having this long type definition, we can use typedef to create an alias, which is the primary purpose of this PR. So, new logIn function would be:

void logIn({required FormBuilderFields fields}) {
  // ...
}

Pros:

• Shorter

Cons (that I can think of):

• There's also a class named FormBuilderField in the library, might lead to confusion or misuse.

To Do

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

[codecov]

Codecov Report

Merging #1154 (8200425) into main (c964ef1) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1154   +/-   ##
=======================================
  Coverage   84.93%   84.93%           
=======================================
  Files          19       19           
  Lines         697      697           
=======================================
  Hits          592      592           
  Misses        105      105           

Impacted Files	Coverage Δ
lib/src/form_builder.dart	69.76% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[erayerdin]

I think the build error stems from something not existing in beta branch. Other PRs as well have this fail.

[deandreamatias]

Hi @erayerdin
Thanks for your contribution
I will think about the name type and review the PR in next days.
I not in home right now