Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JerinFrancisA/flutter_otp
A Flutter package for iOS and Android for sending and verifying OTP to a Phone number.
https://github.com/JerinFrancisA/flutter_otp
android app flutter flutter-package otp phone-number sendotp
Last synced: 2 months ago
JSON representation
A Flutter package for iOS and Android for sending and verifying OTP to a Phone number.
- Host: GitHub
- URL: https://github.com/JerinFrancisA/flutter_otp
- Owner: JerinFrancisA
- License: mit
- Created: 2019-08-21T17:26:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-24T06:00:52.000Z (almost 4 years ago)
- Last Synced: 2024-08-01T19:37:45.091Z (5 months ago)
- Topics: android, app, flutter, flutter-package, otp, phone-number, sendotp
- Language: Dart
- Size: 56.6 KB
- Stars: 61
- Watchers: 4
- Forks: 13
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-list - flutter_otp
README
[](https://github.com/Solido/awesome-flutter)
[](https://github.com/dwyl/esta/issues)
[](https://snyk.io/test/github/dwyl/hapi-auth-jwt2?targetFile=package.json)
[](https://travis-ci.org/dwyl/esta)
# flutter_otp
A Flutter package for Android and iOS for sending and verifying OTP to a Phone number.
### Important message for existing Users
#### NEW FEATURE !!
Now you can send the message to any country code passed as a parameter to the interface (sendOtp() function)
# Installing
## Use this package as a library
### 1. Depend on it
Add this to your package's pubspec.yaml file:
```
dependencies:
flutter_otp: ^0.3.2
```
### 2. Install it
You can install packages from the command line:
with Flutter:
```
$ flutter packages get
```
Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.
### 3. Import it
Now in your Dart code, you can use:
```
import 'package:flutter_otp/flutter_otp.dart';
```
# Functions
The important functions used in the package are :
1. sendOtp() to send a OTP (four digit by default, but customizable):
```
void sendOtp(String phoneNumber, [String messageText]) {
...
}
```
>NOTE:
> 1. 10 digit phoneNumber should be passed.
> 2. parameter "messageText" is optional. By default the message text is "Your OTP is : XXXX". If "messageText" parameter is passed then message is sent as " XXXX".
2. resultChecker() which takes the OTP entered by the user as a parameter. The function returns true if OTP is matched, else false is returned.
```
bool resultChecker(int enteredOtp) {
...
}
```
>NOTE: The OTP entered by user (say, through TextField widget or TextFormField widget etc) is to be passed as a parameter to this function.
# Usage
To use this package in your application you need to have a sim card in your mobile.
Example Usage:
```
...
sendOtp('958347XXXX'); //Pass phone number as String
...
int enteredOtp;
TextField(
onChanged: (val) {
enteredOtp = val;
}
)
...
bool isCorrectOTP = resultChecker();
if(isCorrectOTP) {
print('Success');
} else {
print('Failure');
}
...
```
OR custom "messageText" can be passed as parameter to sendOTP
```
...
sendOtp('958347XXXX', 'OTP is : '); //Pass phone number and Custom messaseText as String
...
int enteredOtp;
TextField(
onChanged: (val) {
enteredOtp = val;
}
)
...
bool isCorrectOTP = resultChecker();
if(isCorrectOTP) {
print('Success');
} else {
print('Failure');
}
...
```
## Contributors
1. [Fawaz Hussain](https://github.com/fawazhussain)
2. [Jerin Francis](https://github.com/JerinFrancisA)
:star: the repo to show support!
## More Information
[Pub package](https://pub.dartlang.org/packages/flutter_otp)
[Flutter documentation](https://flutter.io/).