https://github.com/iamngoni/localregex
Dart implementation of Michael Dera's simple-regex typescript package
https://github.com/iamngoni/localregex
Last synced: about 2 months ago
JSON representation
Dart implementation of Michael Dera's simple-regex typescript package
- Host: GitHub
- URL: https://github.com/iamngoni/localregex
- Owner: iamngoni
- License: mit
- Created: 2020-12-27T23:40:57.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T23:20:57.000Z (11 months ago)
- Last Synced: 2025-03-25T13:01:45.379Z (2 months ago)
- Language: Dart
- Size: 155 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [LocalRegex](https://pub.dev/packages/localregex/)
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
[![License: MIT][license_badge]][license_link]
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license_link]: https://opensource.org/licenses/MIT
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
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](https://github.com/kudak3) & [Donald Chinhuru](https://twitter.com/donix_22) for pushing this package the most.
## Usage
### Add dependency
```yaml
dependencies:
localregex:
```
### Or
```shell
flutter pub add localregex
```
### Import package
```dart
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
```dart
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
```dart
LocalRegex.isZimMobile('mobile_number');
```
### Check if mobile number is valid (recommended for numbers not from Zimbabwe)
```dart
LocalRegex.isValidMobile('mobile_number');
```
### Check if Zimbabwean landline number is valid
```dart
LocalRegex.isZimLandline('landline_number');
```
### Check if a supplied email matches proper email patterns
```dart
LocalRegex.isEmail('email_address');
```
### Check if a supplied national id matches the pattern for Zimbabwean national id
```dart
LocalRegex.isZimID('national_id');
```
### Check passport number
```dart
LocalRegex.isZimPassport('passport_number');
```
### Check number plate
```dart
LocalRegex.isZimNumberPlate('number_plate');
```
### Check driver's license
```dart
LocalRegex.isZimDriversLicence('drivers_license');
```
### Check URL
```dart
LocalRegex.isUrl("https://www.google.com");
```
### Check phone number and returns phone number in required format (for use with Zim numbers only)
```dart
String? number = '+263777213388'.formatNumber(formatType: FormatType.regular);
```
### Check if password is valid (minimum of 8 characters, at least 1 special character, 1 capital letter, 1 numeric character)
```dart
LocalRegex.isPassword('your_password');
```
## Mobile Number Format Types
### Regular
> This is the general format of mobile numbers e.g. 0777213388
```dart
FormatType.regular
```
### Country Code
> This is the mobile number format with country code but no + sign e.g. 263777213388
```dart
FormatType.countryCode
```
### Country Code Plus
> This is the mobile number format with country code and + sign e.g. +263777213388
```dart
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
```dart
'11223344K55'.formatID(formatType: IdFormatType.proper); // > 11-223344 K 55
```
## School Student IDs
You can validate Student IDs for multiple tertiary institutions in Zimbabwe.
```dart
LocalSchools.hit.isStudent('studentID')
```
---
## Contributors
Ngonidzashe Mangudya
Kudakwashe Kuzvindiwana
Donald Chinhuru
Add your contributions