🧱 FormzInput

This brick generates form inputs using the formz package.

🚧 Requirements

Make sure you have the formz package inside your pubspec.yaml file.

Usage 🚀

This brick supports generating form inputs for different data types.

Create a form input for String based fields

In order to create a form input for a String based field, run it like this:

mason make formz_input -o ./output-path --input_name Name --input_type String --initial_value "''" --validate_empty_string true --cache_error_result false

This generates a file named name.dart in the output path.

import 'package:formz/formz.dart';

enum NameValidationError { invalid, empty }

class Name extends FormzInput<String, NameValidationError> {
  const Name.pure() : super.pure('');

  const Name.dirty({String value = ''}) : super.dirty(value);

  @override
  NameValidationError? validator(String value) {
    return value.isEmpty ? NameValidationError.empty : null;
  }
}

Create an input for an int based field

In order to create a form input for an int based field, you could use something like this:

mason make formz_input -o ./output-path --input_name Age --input_type int --initial_value 12 --validate_empty_string false --cache_error_result false

This generates a file named age.dart in the output path, which contains the following code:

import 'package:formz/formz.dart';

enum AgeValidationError { invalid }

class Age extends FormzInput<int, AgeValidationError> {
  const Age.pure() : super.pure(12);

  const Age.dirty({int value = 12}) : super.dirty(value);

  @override
  AgeValidationError? validator(int value) {
    return null;
  }
}

Create an input for a field which caches the error result

In order to create a form input for a field which caches the error result, you could use something like this:

mason make formz_input -o ./output-path --input_name Age --input_type int --initial_value 12 --validate_empty_string false --cache_error_result true

This isn't a very useful example, but it shows how to use the --cache_error_result flag. It makes sense to use this flag when you have a validator which is expensive to run, and you want to cache the result of the validation.

This generates a file named age.dart in the output path, which contains the following code. It also includes the FormzInputErrorCacheMixin:

import 'package:formz/formz.dart';

enum AgeValidationError { invalid }

class Age extends FormzInput<int, AgeValidationError> with FormzInputErrorCacheMixin {
  Age.pure([super.value = 12]) : super.pure();

  Age.dirty([super.value = 12]) : super.dirty();

  @override
  AgeValidationError? validator(int value) {
    return null;
  }
}

Variables ✨

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add formz_input

# Install globally
mason add -g formz_input

Usage 🚀

mason make formz_input

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev <0.1.0"

0.2.1

• Improves the readability of the generated validator code.
• Adds support for the FormzInputErrorCacheMixin.

0.2.0

• Adds support for data types
• Adds support for initial values
• Adds support for omitting the validating of empty strings
• Updates the readme to include the new features and adds more examples

0.1.0+1

• Initial release of the formz_input brick.

MIT License

Copyright (c) 2023 a cup of software, Tim Brückner

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.