https://github.com/codeep/react-recaptcha-google

This library helps to integrate google recaptcha into your react project easily.
https://github.com/codeep/react-recaptcha-google

grecaptcha react react-recaptcha recaptcha

Last synced: about 1 month ago
JSON representation

This library helps to integrate google recaptcha into your react project easily.

• Host: GitHub
• URL: https://github.com/codeep/react-recaptcha-google
• Owner: codeep
• Created: 2018-05-15T10:34:58.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T19:24:11.000Z (about 2 years ago)
• Last Synced: 2024-09-26T16:48:21.010Z (3 months ago)
• Topics: grecaptcha, react, react-recaptcha, recaptcha
• Language: JavaScript
• Homepage: https://developers.google.com/recaptcha/intro
• Size: 1.61 MB
• Stars: 27
• Watchers: 2
• Forks: 20
• Open Issues: 26
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# react-recaptcha-google

This component is created in order to make the experience of integrating Google ReCaptcha into React apps easier and smoother.

Currently, we are using ReCaptcha V2 here. ReCaptcha V3 is still in beta version; so, we will update our component when they release the stable version.

P.S. It will open the ReCaptcha window only when there are some doubts by Google; otherwise, it will automatically generate the recaptcha token.

## Installation

`npm install react-recaptcha-google --save`

## Usage

There are two components that you need to use.

### 1. Use `loadReCaptcha()` to initialize the ReCaptcha

This function should be imported and called in the main (parent) component of your app. We recommend calling it in `componentDidMount()` of `App.js`.

```

import { loadReCaptcha } from 'react-recaptcha-google'

...

componentDidMount() {

  loadReCaptcha();

}

```

### 2. Use `ReCaptcha` to integrate ReCaptcha in a particular component

#### invisible Recaptcha

Create a new component with the following code and give it a try!

```

import React, { Component } from 'react';

import { ReCaptcha } from 'react-recaptcha-google'

class ExampleComponent extends Component {

  constructor(props, context) {

    super(props, context);

    this.onLoadRecaptcha = this.onLoadRecaptcha.bind(this);

    this.verifyCallback = this.verifyCallback.bind(this);

  }

  componentDidMount() {

    if (this.captchaDemo) {

        console.log("started, just a second...")

        this.captchaDemo.reset();

        this.captchaDemo.execute();

    }

  }

  onLoadRecaptcha() {

      if (this.captchaDemo) {

          this.captchaDemo.reset();

          this.captchaDemo.execute();

      }

  }

  verifyCallback(recaptchaToken) {

    // Here you will get the final recaptchaToken!!!  

    console.log(recaptchaToken, "<= your recaptcha token")

  }

  render() {

    return (

      


        {/* You can replace captchaDemo ref with whatever works for your component */}

         {this.captchaDemo = el;}}

            size="invisible"

            render="explicit"

            sitekey="your_site_key"

            onloadCallback={this.onLoadRecaptcha}

            verifyCallback={this.verifyCallback}

        />

        

          1. Add your site key in the ReCaptcha component. 


          2. Check console to see the token.

        

      

    );

  };

};


export default ExampleComponent;

```

#### Visible / Normal Recaptcha

For having a visible ReCaptcha, you should make two minor changes on the above-mentioned code.

1. Replace the size prop value `invisible` (see the imported ReCaptcha component) with either `normal` or `compact`. Those will add a checkbox with 'I am not a robot' label.

2. Remove `this.[captchaRef].execute()` lines from your code.

##### Optional props

* `data-theme` - you can add `theme` prop with a value of either `"dark"` or `"light"`(default) to control the background theme of the visible ReCaptcha (when size is `normal` or `compact`)

* `data-badge` - you can send `badge` prop with one of the following values: bottomright (default), bottomleft, inline. This will allowyou to reposition the ReCaptcha badge.

### 3. Save Google response into state or inside a hidden field

```

  verifyCallback(recaptchaToken) {

    const {

      change

    } = this.props;

    // inside hidden field

    change('recaptchaResponse', recaptchaToken);

    // or state

    this.setState('recaptchaResponse', recaptchaToken)

  }

  

  render() {

  ...

  return {

     

       ...

       }

```

### 4. Implement code server side to validate the response

```

import * as request from 'request'; // from "web-request": "^1.0.7",

async check(recaptchaResponse: string, remoteAddress: string): Promise {

 const secretKey = "";

    return new Promise((resolve, reject) => {

      const verificationUrl = 'https://www.google.com/recaptcha/api/siteverify?secret=' + secretKey + '&response=' + recaptchaResponse + '&remoteip=' + remoteAddress;

      request(verificationUrl

        , function(error, response, body) {

          if (error) {

            return reject(false);

          }

          if (response.statusCode !== 200) {

            return reject(false);

          }

          body = JSON.parse(body);

          const passCaptcha = !(body.success !== undefined && !body.success);

          resolve(passCaptcha);

        });

    });

  }

```