1.0.1 • Published 3 years ago
rn-otp-timer v1.0.1
rn-otp-timer
A standalone , fully customizable Otp timer you can easily use.
Installation
npm install rn-otp-timerUsage
import RnOtpTimer from 'rn-otp-timer';
<RnOtpTimer
minutes={0}
seconds={40}
resendButtonStyle={styles.button}
resendButtonTextStyle={styles.buttonText}
resendButtonAction={() => {
console.log('otp resent!');
}}
/>;Parameters
| Parameter | Required | Description |
|---|---|---|
| minutes | No | Number of minutes for which the timer must be set |
| seconds | No | Number of seconds for which the timer must be set |
| resendButtonText | No | Set resend button text content |
| resendButtonAction | Yes | Callback when resend button is clicked |
| timerStyle | No | Props for styling timer content |
| resendButtonStyle | Yes | Props for styling resend button |
| resendButtonTextStyle | Yes | Props for styling resend button text |
Development workflow
To get started with the project, run yarn in the root directory to install the required dependencies for each package:
yarnWhile it's possible to use
npm, the tooling is built aroundyarn, so you'll have an easier time if you useyarnfor development.
While developing, you can run the example app to test your changes.
To run the example app on Android, go to example app directory and run:
yarn androidContributing
Pull requests are welcome . For major changes, please open an issue first to discuss what you would like to change.