flutter_hook_form 3.0.0

flutter_hook_form: ^3.0.0 copied to clipboard

Breaking changes #

• 💥 FormSchema generator has been removed as the generated code did not justify keeping the generator. Indeed, the only perk of the generator was to avoid having to write by hand the id of each hook field.

Migration guide: Simply expose the generated form schema and remove the file that was used for generation.

Improvements #

• 📝 : update code comments to pass static analysis.

Fix #

• 🐛 Fix "type 'LabeledGlobalKey" error that occured when using isDirty function.

• 🔧 Upgrade dart SDK to ^3.8.0

Fix #

• 🐛 Missing default return when localizing forced error code.

Improvements #

• Update path dependency version constraint to allow for minor updates

Improvements #

• 🐛 Fix unnecessary array creation in useForm hook keys parameter.

Improvements #

• ♻️ Update initialization business logic to avoid loosing initial value state on rebuild.

Improvements #

• 🐛 Fix MimeTypeValidator for failing on valid files.

Breaking changes #

• 💥 FormProvider has been renamed to HookedFormProvider
• 💥 FormFieldScheme and HookedFieldId have been merged into HookField
• 💥 FormSchema now declare a fields property to setup form fiels instead of using super constructor
• 💥 builder syntax has changed on HookedFormField allowing to declare anonymous parameters.

Improvements #

• 🐛 Fix PatternValidator for failing on empty strings. Now fails only on non-empty values.

New Features #

• ✨ FormController can now be initialized
  • Generated FormSchema declare a static to initialized each HookField
  • withInitialValue method has been added to HookField to initialized a hook field with a given value.

Improvements #

• ✨ Enhanced FormFieldsController with improved validation and error handling:
  • Added optional notify and clearErrors parameters to validate() method for more control
  • Added setError() method with notify parameter to control rebuilds
  • Introduced clearForcedErrors() method to manage form errors independently
  • Added new state tracking properties:
    • hasBeenInteracted - Detects if any field has been interacted with by user
    • hasChanged - Checks if any field value differs from its initial value

Fix #

• 🐛 Update form generator to correctly identify closing brackets for generic types in annotations.

New Features #

• ✨ Introduced HookedFieldId<F, T> with generic type parameters for improved type safety:

  • The form schema type F is now included in the field ID
  • This enables better type inference when using form fields
  • No need to specify form schema type in most widget usages

• 🔄 Added reactive form capabilities:

  • Form controller now properly notifies listeners when field values change
  • Added registerFieldChange method to track field modifications
  • Added methods to check if fields are dirty: isDirty, areAnyDirty, areAllDirty

• ✨ Introduced HookedFormField and HookedTextFormField:

  • Updated to use the new fieldHook parameter instead of fieldKey
  • Better type inference from field hooks
  • Added support for tracking field changes

Improvements #

• 📝 Comprehensive documentation updates:

  • Added examples for custom form fields
  • Improved explanation of form initialization
  • Added section on writing custom form fields
  • Updated code examples to use the latest API

• 🐛 Fixed validation issues:

  • Resolved bug where forced errors took precedence over validation errors
  • Improved error clearing during validation
  • Better handling of field rebuilds after validation

Breaking Changes #

• 🔄 Renamed parameter from fieldKey to fieldHook in form field widgets
  • Update your code to use fieldHook: MySchema.field instead of fieldKey: MySchema.field
  • This change better reflects the purpose of the parameter

Breaking Changes #

• ⚠️ Validator usage has been updated to support internationalization:

  • Validators are now declared in a list instead of being chained in a function.
  • Validators now return errorCode instead of error messages
  • Error messages are handled through the FormErrorMessages class
  • Custom validators need to extend Validator<T> and provide an errorCode
  • See the documentation for migration details

• ✨ Add code generation support for form schemas

• 🌍 Add built-in internationalization support

• 🛠️ Improve code organization and maintainability

• Add comprehensive documentation
• Update exports
• Add example for package demonstration

• Downgrade mime package to 1.0.6

• Add test suite and improve comments

• Init project