Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

react-recaptcha-v3

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-recaptcha-v3

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

  • 2.0.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4.9K
decreased by-1.09%
Maintainers
1
Weekly downloads
 
Created
Source

react-recaptcha-v3

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 V3, which 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.

Google ReCaptcha V3

Installation

npm install react-recaptcha-v3 --save

Usage

First of all, get your site key for ReCaptcha V3 here

There are two steps that you need to implement.

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-v3'

...

componentDidMount() {
  loadReCaptcha(your_site_key, callback);
}

loadRecaptcha API

ParametersTypeDefaultRequiredDescription
your_site_keystringundefinedtrueCorresponds to the site key you get from here
callbackfunc() => {}falseFunction called when grepcaptcha is correctly loaded

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-v3'

class ExampleComponent extends Component {

  verifyCallback = (recaptchaToken) => {
    // Here you will get the final recaptchaToken!!!  
    console.log(recaptchaToken, "<= your recaptcha token")
  }

  updateToken = () => {
    // you will get a new token in verifyCallback
    this.recaptcha.execute();
  }
  render() {
    return (
      <div>

        <ReCaptcha
            ref={ref => this.recaptcha = ref}
            sitekey="your_site_key"
            action='action_name'
            verifyCallback={this.verifyCallback}
        />

        <h2>Google ReCaptcha with React </h2>

        <code>
          1. Add <strong>your site key</strong> in the ReCaptcha component. <br/>
          2. Check <strong>console</strong> to see the token.
        </code>
      </div>
    );
  };
};

export default ExampleComponent;

ReCaptcha props

ParametersTypeDefaultRequiredDescription
sitekeystringundefinedtrueCorresponds to the site key you get from here
actionstringundefinedtrueName of the action performed by the reCaptcha, more on that here
verifyCallbackfuncundefinedfalseThis function will be called when reCaptcha is ready, and receives the recaptchaToken as the first and unique parameter
Actions

The ReCaptcha block can be triggered without a callback in order to trigger an action.

See https://developers.google.com/recaptcha/docs/v3#Actions for more Information.

<ReCaptcha
    sitekey="your_site_key"
    action='action_name'
/>

Keywords

FAQs

Package last updated on 14 Jun 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc