React OTP Input In Spfx

Introduction

The react-otp-input is a plugin written in React.js to initialize the React otp input component in React forms.

Open a command prompt. Create a directory for the SPFx solution.

md spfx-Otpinput

Navigate to the above-created directory.

cd spfx-Otpinput

Run the Yeoman SharePoint Generator to create the solution.

yo @microsoft/sharepoint

Solution Name

Hit Enter to have the default name (spfx-Otpinput in this case) or type in any other name for your solution.

Selected choice - Hit Enter

Target for the component

Here, we can select the target environment where we are planning to deploy the client web part, i.e., SharePoint Online or SharePoint OnPremise (SharePoint 2016 onwards).

Selected choice - SharePoint Online only (latest).

Place of files

We may choose to use the same folder or create a subfolder for our solution.

Selected choice - same folder.

Deployment option

Selecting Y will allow the app to be deployed instantly to all sites and be accessible everywhere.

Selected choice - N (install on each site explicitly).

Permissions to access web APIs

Choose if the components in the solution require permission to access web APIs that are unique and not shared with other components in the tenant.

Selected choice - N (solution contains unique permissions)

Type of client-side component to create

We can choose to create a client-side web part or an extension. Choose the web part option.

Selected choice - WebPart

Web part name

Hit Enter to select the default name or type in any other name.

Selected choice - ReactOtpInput

Web part description

Hit Enter to select the default description or type in any other value.

Framework to use

Select any JavaScript framework to develop the component. Available choices are - No JavaScript Framework, React, and Knockout.

Selected choice - React

The Yeoman generator will perform a scaffolding process to generate the solution. The scaffolding process will take a significant amount of time.

Once the scaffolding process is completed, lock down the version of project dependencies by running the below command,

npm shrinkwrap

In the command prompt, type the below command to open the solution in the code editor of your choice.

NPM Packages used:

npm install --save react-otp-input

Necessary imports:

import OtpInput from 'react-otp-input';

To initialize otp input component, insert the below tag in render method:

<OtpInput
onChange={this.handleChange}
numInputs={6}
separator={<span>-</span>}
/>

Styling the component

inputStyle={{
width: '3rem',
height: '3rem',
margin: '20px 1rem',
fontSize: '2rem',
borderRadius: 4,
border: '2px solid rgba(0,0,0,0.3)',
}}

As per your own css, you can change the look of the component.

Full code

In ReactOtpInput.tsx

import * as React from 'react';
import { IReactOtpInputProps } from './IReactOtpInputProps';
import OtpInput from 'react-otp-input';
export interface IOtopState {
otp?:string;
}
/*
this.state = {
otp: '',
numInputs: 4,
separator: '-',
isDisabled: false,
hasErrored: false,
isInputNum: false,
}; */
export default class ReactOtpInput extends React.Component<IReactOtpInputProps,IOtopState> {
constructor(props) {
super(props);
this.state = {
otp: '',
}; this.handleChange = this.handleChange.bind(this);
this.clearotp = this.clearotp.bind(this);
}
public handleChange = otp => {
this.setState({ otp });
console.log(otp);
}
public clearotp = () => {
this.setState({ otp:'' });
}
public render(): React.ReactElement<IReactOtpInputProps> {
return (
<div >
<OtpInput
inputStyle={{
width: '3rem',
height: '3rem',
margin: '20px 1rem',
fontSize: '2rem',
borderRadius: 4,
border: '2px solid rgba(0,0,0,0.3)',
}}
onChange={this.handleChange}
numInputs={6}
separator={<span>-</span>}
shouldAutoFocus
value={this.state.otp}
isInputNum={true}
/>
<button
className="btn margin-top--large"
disabled={this.state.otp.toString().length < 6}
>
Verify OTP
</button>
<button
className="btn margin-top--large"
onClick={this.clearotp}
>
clear otp
</button>
</div>
);
}
}

Properties

numInputs - It specifies the number of input boxes.
onChange -This event caputres the state value when input will change.
isDisabled- it disabled all the inputs.
shouldAutoFocus -autofocus the input when the page load.
isInputNum - it restricts input to only numbers.
separator- it specifies the textboxes break.
value-its the final output value of the value entered.

Sample output

Conclusion

We learned about initializing React otp component in Spfx forms using react-otp-input plugin. I hope this helps someone. Happy coding :)