donnc/localregex

Dart implementation of Michael Dera's simple-regex typescript package

LocalRegex

This plugin allows developers to check if an input matches common regex patterns in Zimbabwe and other countries. This plugin works for all Flutter supported platforms i.e. Android, iOS, Web and Desktop (Linux, Windows & MacOS).

Developed by Ngonidzashe Mangudya. Special shoutout to Kudakwashe Kuzvindiwana for pushing this package the most.

Usage

Add dependency

dependencies:
  localregex: <version>

Or

flutter pub add localregex

Import package

  import 'package:localregex/localregex.dart';

Note that declaration and initialization is no longer necessary

Check if a mobile number matches patterns for Econet, Netone or Telecel numbers

LocalRegex.isNetone('mobile_number');
LocalRegex.isEconet('mobile_number');
LocalRegex.isTelecel('mobile_number');

Check if a mobile number matches any of the patterns for Econet, Netone or Telecel

LocalRegex.isZimMobile('mobile_number');

Check if mobile number is valid (recommended for numbers not from Zimbabwe)

LocalRegex.isValidMobile('mobile_number');

Check if a supplied email matches proper email patterns

LocalRegex.isEmail('email_address');

Check if a supplied national id matches the pattern for Zimbabwean national id

LocalRegex.isZimID('national_id');

Check passport number

LocalRegex.isZimPassport('passport_number');

Check number plate

LocalRegex.isZimNumberPlate('number_plate');

Check driver's license

LocalRegex.isZimDriversLicence('drivers_license');

Check URL

LocalRegex.isUrl("https://www.google.com");

Check mobile number and returns mobile number in required format (for use with Zim numbers only)

String? number = '[phone]'.formatNumber(formatType: FormatType.regular);

Check if password is valid (minimum of 8 characters, at least 1 special character, 1 capital letter, 1 numeric character)

LocalRegex.isPassword('your_password');

Mobile Number Format Types

Regular

This is the general format of mobile numbers e.g. 0777213388

FormatType.regular

Country Code

This is the mobile number format with country code but no + sign e.g. 263777213388

FormatType.countryCode

Country Code Plus

This is the mobile number format with country code and + sign e.g. [phone]

FormatType.countryCodePlus

Format National ID

Here the output format to be used is 11-223344 K 55 as found on most national identity documents in Zimbabwe

'11223344K55'.formatID(formatType: IdFormatType.proper); // > 11-223344 K 55