Boolean Validation #

I basically build this Package so Devs can use

1. A complete set of regex patterns for common validation needs.
2. Handy shorthand methods to simplify built-in TextFormField validation.
3. isValid methods for easy bool checks in any context.
4. Built-in validation messages with override and localization support.
5. Customizable "required" messages globally or per field type.
6. Field-specific messages that override the default ones when needed.
7. Support for validating email addresses with specific domain rules.
8. Phone number validation tailored for 19 supported countries.
9. Validate alphabetic characters for 10 languages, allowing checks against one or multiple selected languages (e.g., English and Arabic).

Table of Contents #

• Some Visual References
  • Overview Graph
  • Full Detailed Graph
• Get Ready
• Available Validators
  • User Input Validators
  • Data Type Validators
• Some Complex Examples
  • Email Constrained Domain Validation
  • Mobile Number Validation
  • Password Validation
  • Name Validation
  • Run Many Validation Logic
• Contributing
• License

Some Visual References #

Overview Graph #

graph TD
    A[boolean_validation] --> B[Validators Class]
    A[boolean_validation] --> F[Validation Messages]
    B --> C[UserInputValidators]
    B --> D[DataTypeValidators]
    B --> E[LocationValidators]
    C --> C1[validateEmail]
    C --> C2[validateConstrainedEmail]
    C --> C3[validateUsername]
    C --> C4[validateFullName]
    C --> C5[validateName]
    C --> C6[validatePassword]
    C --> C7[validateCreditCard]
    D --> D1[validateInteger]
    D --> D2[validateDouble]
    D --> D3[validatePositiveNum]
    D --> D4[validateUrl]
    D --> D5[validateDate]
    D --> D6[validateAlpha]
    D --> D7[validateAlphanumeric]
    E --> E1[validateLat]
    E --> E2[validateLong]

Fully Detailed: #

[Architecture Diagram]

Get Ready #

Add to your pubspec.yaml:

dependencies:
  boolean_validation: ^1.0.0

Basic usage:

import 'package:boolean_validation/boolean_validation.dart';

final validators = Validators();

// Validate email
TextFormField(
    controller: TextEditingController(),
    decoration: InputDecoration(
        labelText: 'Email',
        border: OutlineInputBorder(),
      ),
    keyboardType: TextInputType.emailAddress,
    validator: (value) =>
        _validators.userInput.validateEmail(value,
            // in case of using arb as localization
            customRequiredMessage: l10n.emailRequired,
            customInvalidMessage:l10n.invalidEmail,
           ),
    ),

Available Validators #

User Input Validators #

Data Type Validators #

Some Complex Examples #

Email Constrained Domain Validation #

  String? validateConstrainedEmail(String? value, {
  required EmailDomain domain,
  bool isRequired = true,
  String? customRequiredMessage,
  String? customInvalidMessage,
});

Mobile Number Validation #

String? validateMobileNumber(String? value,
    {
      bool isRequired = true,
      String? customRequiredMessage,
      String? customInvalidMessage,
      String? prefix,
    });

Password Validation #

 String? validatePassword(String? value, {
  int minLength = 8,
  bool requireUppercase = true,
  String? customUppercaseMessage,
  bool requireDigit = true,
  String? customDigitMessage,
  bool requireSpecialChar = true,
  String? customSpecialCharMessage,
});

Name Validation #

String? validateName(String? value, {
  bool isRequired = true,
  String? customRequiredMessage,
  String? customInvalidMessage,
  List<SupportedLanguage> multiLang = const [SupportedLanguage.english],
});

Run Many Validation Logic #

bool runMultiValidators({
  required List<bool Function()> validators,
});

Example

class ShowCaseForMixinValidator extends StatefulWidget {
  const ShowCaseForMixinValidator({super.key});

  @override
  State<ShowCaseForMixinValidator> createState() =>
          _ShowCaseForMixinValidatorState();
}

Notice the use of Mixin ValidationLogic with the with keyword to access all the methods directly

class _ShowCaseForMixinValidatorState extends State<ShowCaseForMixinValidator>
        with ValidationLogic {
  @override
  void initState() {
    super.initState();
    var result = runMultiValidators(validators: [
      isInteger('4'),
      isPositiveNum('4'),
    ]);
    debugPrint("output result is $result");
    // output result is true
  }

  @override
  Widget build(BuildContext context) {
    return const Placeholder();
  }
}

Contributing #

Contributions are welcome! Please feel free to submit a Pull Request.

License #

This project is licensed under the MIT License - see the LICENSE file for details.