React Captcha Generator In Spfx

Introduction

 

The React Captcha Generator is a plugin written in React.js to generate a captcha in React forms.

 

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

 

md spfx-captcha

 

Navigate to the above-created directory.

 

cd spfx-captcha

 

Run the Yeoman SharePoint Generator to create the solution.

 

yo @microsoft/sharepoint

 

Solution Name

 

Hit Enter to have the default name (spfx-captcha 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 - Reactcaptcha

 

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,

 

On the command prompt, run the below commands

npm i react-captcha-generator

Necessary imports for captcha plugin:

import  ReactCaptchaGenerator from 'react-captcha-generator';

To initialize captcha, insert the below tag in render method:

<ReactCaptchaGenerator result={this.result} />

Full Code

import * as React from 'react';
import { IReactcaptchaProps } from './IReactcaptchaProps';
import  ReactCaptchaGenerator from 'react-captcha-generator';
export interface ICaptchaState {
  captcha?:string;
}
export default class Reactcaptcha extends React.Component<IReactcaptchaProps, ICaptchaState> {
  private  recaptchaRef = React.createRef<HTMLInputElement>();
  constructor(props) {
    super(props);
    this.state = {
      captcha: '',

    };
    this.check = this.check.bind(this);
    this.result = this.result.bind(this);
    this.submitform = this.submitform.bind(this);
  /*  this.resetclick = this.resetclick.bind(this);*/
  }
  public render(): React.ReactElement<IReactcaptchaProps> {

    return (
      <div className="MyApp">
        <ReactCaptchaGenerator result={this.result} />
      <form onSubmit={this.submitform}>
          <input type='text' className={'myinput'} ref={this.recaptchaRef} />
          <input type='submit' />
        </form>
    </div>
    );
  }
/* public resetclick(e) {
    e.preventDefault();
   // this.forceUpdate();

  }*/
  public submitform=(e) =>{
    e.preventDefault();
    this.check();
  }

  public result=(text)=> {
    this.setState({
      captcha: text
    });
  }

  public check=()=> {
   console.log(this.state.captcha, this.recaptchaRef.current.value, this.state.captcha === this.recaptchaRef.current.value);
  }
}

Since the author of the plugin only focused on componentwillmount method and not on componentdidupdate method, we are unable to rerender the component (i.e. not able to refresh the captcha; if we want to refresh the captcha we need to reload the enter page).

 

Output of captcha Plugin,

 

 

Captcha Verification in console output.

 

Wrong captcha 

 

 

Correct Captcha

 

 

Conclusion

 

Hence we learned about initializing captcha in Spfx form using the React Captcha Generator plugin. I hope this helps someone. Happy coding :)