added description for the new field

flutter-form-builder-ecosystem / form_builder_file_picker

File picker field widget for FlutterFormBuilder.

https://pub.dev/packages/form_builder_file_picker

BSD 3-Clause "New" or "Revised" License

15 stars 33 forks source link

added description for the new field #35

Closed grundid closed 2 years ago

grundid commented 2 years ago

Added description for the new field typeSelectors.

deandreamatias commented 2 years ago

Maybe need added a description that when use typeSelectors, type and selector don't be used by this widget. A code verification (assert) should be nice too

grundid commented 2 years ago

Maybe need added a description that when use typeSelectors, type and selector don't be used by this widget. A code verification (assert) should be nice too

I guess an assertion will not work here since type and selector both have default values. Maybe it would be better to deprecate type and selector and put the current values into typeSelectors?

deandreamatias commented 2 years ago

Seems ok for me. Can add a @deprecated with a message in type and selector properties and add a documentation to readme with this new behaviour. In first time, I release a minor version with this. When will has more change, I can release a major update and remove this deprecated properties

grundid commented 2 years ago

You want me to add something or is the current version OK?

deandreamatias commented 2 years ago

@grundid please add this

a @deprecated with a message to type and selector properties
documentation to readme about this deprecated properties and how typeSelectors replace this deprecated properties

Thanks a lot!

deandreamatias commented 2 years ago

@grundid When you can, please update the main example Thanks