# react-native-simple-otp

> is a library for react-native that just makes handling otp easy.

Latest version **1.0.1** (published 2022-06-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-simple-otp
pnpm add react-native-simple-otp
yarn add react-native-simple-otp
bun add react-native-simple-otp
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-06-02 |
| First published | 2022-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 29.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Saheem Hussain |
| Maintainers | saheemhussain |
| Keywords | react-native, otp, otc, one time password, one time pin, one time pincode, one time code, sms, verifcation code, phone, verification |

## Links

- npm: https://www.npmjs.com/package/react-native-simple-otp
- Repository: https://github.com/saheem128/react-native-simple-otp
- Homepage: https://github.com/saheem128/react-native-simple-otp#readme
- Issues: https://github.com/saheem128/react-native-simple-otp/issues
- npm.io page: https://npm.io/package/react-native-simple-otp

## Dependencies (1)

- [@react-native-community/clipboard](https://npm.io/package/@react-native-community/clipboard.md) ^1.2.2

## Recent versions

- 1.0.1 (latest) — 2022-06-02
- 1.0.0 — 2022-06-02

## README

# React Native Simple OTP

**react-native-simple-otp** is a library for react-native that just makes handling otp easy.

## Installation

`npm install --save react-native-simple-otp`
or
`yarn add react-native-simple-otp`

## Basic Usage

```js
import OTPInputView from 'react-native-simple-otp'

...

<OTPInputView pinCount={4} />

```

## More Advanced Usage

```js
import OTPInputView from 'react-native-simple-otp'

...

<OTPInputView
    style={{width: '80%', height: 200}}
    pinCount={4}
    // code={this.state.code} //You can supply this prop or not. The component will be used as a controlled / uncontrolled component respectively.
    // onCodeChanged = {code => { this.setState({code})}}
    autoFocusOnLoad
    codeInputFieldStyle={styles.underlineStyleBase}
    codeInputHighlightStyle={styles.underlineStyleHighLighted}
    onCodeFilled = {(code) => {
        console.log(`Code is ${code}, you are good to go!`)
    }}
/>

const styles = StyleSheet.create({
  borderStyleBase: {
    width: 30,
    height: 45
  },

  borderStyleHighLighted: {
    borderColor: "#03DAC6",
  },

  underlineStyleBase: {
    width: 30,
    height: 45,
    borderWidth: 0,
    borderBottomWidth: 1,
  },

  underlineStyleHighLighted: {
    borderColor: "#03DAC6",
  },
});

```

## Parameters

| Parameter               | required | Description                                                                                     |
| ----------------------- | -------- | ----------------------------------------------------------------------------------------------- |
| pinCount                | YES      | Number of digits in the component                                                               |
| code                    | NO       | You can use this library as a controlled / uncontrolled component by supplying this prop or not |
| codeInputFieldStyle     | NO       | The style of the input field which is NOT focused                                               |
| codeInputHighlightStyle | NO       | The style of the input field which is focused                                                   |
| autoFocusOnLoad         | NO       | Auto activate the input and bring up the keyboard when component is loaded                      |
| onCodeChanged           | NO       | Callback when the digits are changed                                                            |
| onCodeFilled            | NO       | Callback when the last digit is entered                                                         |
| secureTextEntry         | NO       | Hide contents of text fields                                                                    |
| editable                | NO       | Set editable for inputs                                                                         |
| keyboardAppearance      | NO       | Keyboard appearance ('default', 'dark', 'light')                                                |
| keyboardType            | NO       | Keyboard type                                                                                   |
| clearInputs             | NO       | Clear inputs after entering code                                                                |
| placeholderCharacter    | NO       | The character/string that will be used as placeholder in the individual code input fields       |
| placeholderTextColor    | NO       | Color of the placeholderCharacter                                                               |

## Notes

The iOS input suggestion requires React Native 0.58+ and works for iOS 12 and above.

On Android, it will be auto filled when you press the copy code button in the notification bar. It will do so only if the code is sent after the view is loaded. So make sure you request the code **AFTER** this view is loaded.

---
_Source: https://npm.io/package/react-native-simple-otp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._