formz 0.5.0-dev.1

formz: ^0.5.0-dev.1 copied to clipboard

• docs: use nullable validator in README

• feat: add example Flutter app

• BREAKING: decouple purity, validity, and submission status

  Changes #

  1. FormzStatus renamed to FormzSubmissionStatus:

  /// Enum representing the submission status of a form.
  enum FormzSubmissionStatus {
  /// The form is in the process of being submitted.
  inProgress,
  
  /// The form has been submitted successfully.
  success,
  
  /// The form submission failed.
  failure,
  
  /// The form submission has been canceled.
  canceled
  }
  

  2. FormzInput class no longer exposes a status (FormzInputStatus). Instead there are isValid and isNotValid getters:

  class NameInput extends FormzInput<String, NameInputError> {
  const NameInput.pure() : super.pure('');
  const NameInput.dirty({String value = ''}) : super.dirty(value);
  
  @override
  NameInputError? validator(String value) {
      return value.isNotEmpty == true ? null : NameInputError.empty;
  }
  }
  
  void main() {
  const name = NameInput.pure();
  print(name.isValid); // false
  print(name.isNotValid); // true
  
  const joe = NameInput.dirty(value: 'joe');
  print(joe.isValid); // true
  print(joe.isNotValid); // false
  }
  

  3. FormzInput has a displayError getter which returns an error to display if the input is not valid and has been modified by the user (closes #44)

  void main() {
  const name = NameInput.pure();
  print(name.displayError); // null
  
  const invalid = NameInput.dirty(value: '');
  print(name.displayError); // NameInputError.empty
  }
  

  4. Renamed pure to isPure for consistency

• feat: add submissionCanceled to FormzStatus

• BREAKING: opt into null safety
• feat!: upgrade Dart SDK constraints to >=2.12.0-0 <3.0.0

• BREAKING: opt into null safety
• feat!: upgrade Dart SDK constraints to >=2.12.0-0 <3.0.0

• chore: fix code formatting
• ci: update to Dart 2.10.0

• Allow value to be null in FormzInput

• Add FormzMixin
• Fix Formz.validate to take pure into consideration
• Lint improvements

• Remove redundant extensions on FormzInputStatus
• Add isValidated extension on FormzStatus
• Add invalid getter to FormzInput

• Add extensions on FormzStatus
• Add extensions on FormzInputStatus

Initial Release of the formz.