@reiiyuki/react-otp-input
v1.0.2
Published
A fully customizable, one-time password input component for the web built with React
Downloads
4
Readme
react-otp-input
A fully customizable, one-time password input component for the web built with React.
Installation
To install the latest stable version:
npm install --save react-otp-input
Basic usage:
import React, { Component } from 'react';
import OtpInput from 'react-otp-input';
export default class App extends Component {
render() {
return (
<div>
<OtpInput
onChange={otp => console.log(otp)}
numInputs={6}
separator={<span>-</span>}
/>
</div>
);
}
}
API
Breaking changes when porting to v1.0.0
react-otp-input
is now a controlled component to facilitate functionalities that weren't possible before from the application using it, such as clearing or pre-assigning values. For v1.0.0
and above, a value
prop needs to be passed in the component for it function as expected.
Development
To run the development server:
npm run dev
To run the development server for example:
npm run docs
To make a production build of the example:
npm run docs:prod
Checklist
- [x] Add flowtypes
- [x] Add ESLint, Prettier for code quality
- [x] Add styling support for states including focus/disabled
- [ ] Travis CI, Codecov
- [ ] Write tests
Contributing
Feel free to open issues and pull requests!
License
MIT