otp-input-react
A fully customizable, one-time password input component for the web built with React functional component.
Installation
npm install --save otp-input-react
Usage:
function App() {
const [OTP, setOTP] = useState("");
return (
<OTPInput
value={OTP}
onChange={setOTP}
autoFocus
OTPLength={4}
otpType="number"
disabled={false}
secure
/>
);
}
API
Name
| Type | Required | Default | Description | Status |
---|
OTPLength | number | false | 4 | Number of input boxes. | Working |
onChange | function | true | - | Returns OTP code typed in inputs. | Working |
value | string / number | true | '' | The value of the otp passed into the component. | Working |
disabled | boolean | false | false | Disables all the inputs. | Working |
autoFocus | boolean | false | false | Auto focuses input on inital page load. | Working |
otpType | Enum: any|number | false | any | any - allows any value. number - allow only numbers. | Working |
secure | Boolean | false | false | Change input type to password. | Working |
inputClassName | String | - | - | Class for root element. | Working |
className | String | - | - | Class for root element. | Working |
Contributing
Feel Free to contributing or feture request
- Fork it ( https://github.com/shubhanus/otp-input-react/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new pull request.