React Google Recaptcha V3

Install

npm install react-google-recaptcha-v3

Usage

Provide Recaptcha Key

To use

react-google-recaptcha-v3

Enterprise

When you enable to use the enterprise version, you must create new keys. These keys will replace any Site Keys you created in reCAPTCHA. Check the migration guide.

To work properly, you must select the Integration type to be

Scoring

The complete documentation to the enterprise version you can see here.

Components

GoogleReCaptchaProvider

react-google-recaptcha-v3

GoogleReCaptchaProvider

GoogleReCaptchaProvider

Usually, your application only needs one provider. You should place it as high as possible in your React tree. It's to make sure you only have one instance of Google Recaptcha per page and it doesn't reload unecessarily when your components re-rendered.

Same thing applied when you use this library with framework such as Next.js or React Router and only want to include the script on a single page. Try to make sure you only have one instance of the provider on a React tree and to place it as high (on the tree) as possible.

| Props | Type | Default | Required? | Note | | --------------- | :------: | ----------: | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | reCaptchaKey | Boolean | | Yes | Your recaptcha key, get one from here | | scriptProps | Object | | No | You can customize the injected

script

async

defer

nonce

appendTo

useRecaptchaNet

recaptcha.net

import { GoogleReCaptchaProvider } from 'react-google-recaptcha-v3';

ReactDom.render(
  
    
  ,
  document.getElementById('app')
);

There are three ways to trigger the recaptcha validation: using the

GoogleReCaptcha

withGoogleReCaptcha

useGoogleReCaptcha

GoogleReCaptcha

GoogleRecaptcha

onVerify

import {
  GoogleReCaptchaProvider,
  GoogleReCaptcha
} from 'react-google-recaptcha-v3';

ReactDom.render(
  
    
  ,
  document.getElementById('app')
);

// IMPORTANT NOTES: The GoogleReCaptcha component is a wrapper around useGoogleRecaptcha hook and use useEffect to run the verification.
// It's important that you understand how React hooks work to use it properly.
// Avoid using inline function for the onVerify props as it can possibly cause the verify function to run continously.
// To avoid that problem, you can use a memoized function provided by React.useCallback or a class method
// The code below is an example that inline function can result in an infinite loop and the verify function runs continously:

const MyComponent: FC = () => {
  const [token, setToken] = useState();
  return (
    

       {
          setToken(token);
        }}
      />
    


  );
};

React Hook: useGoogleReCaptcha (recommended approach)

If you prefer a React Hook approach over the old good Higher Order Component, you can choose to use the custom hook

useGoogleReCaptcha

withGoogleReCaptcha

The

executeRecaptcha

How to use the hook:

import {
  GoogleReCaptchaProvider,
  useGoogleReCaptcha
} from 'react-google-recaptcha-v3';

const YourReCaptchaComponent = () => {
  const { executeRecaptcha } = useGoogleReCaptcha();
  // Create an event handler so you can call the verification on button click event or form submit
  const handleReCaptchaVerify = useCallback(async () => {
    if (!executeRecaptcha) {
      console.log('Execute recaptcha not yet available');
      return;
    }
const token = await executeRecaptcha('yourAction');
// Do whatever you want with the token
  }, []);
  // You can use useEffect to trigger the verification as soon as the component being loaded
  useEffect(() => {
    handleReCaptchaVerify();
  }, [handleReCaptchaVerify]);
  return Verify recaptcha;
};
ReactDom.render(
  
    
  ,
  document.getElementById('app')
);

withGoogleReCaptcha

GoogleRecaptcha

googleReCaptchaProps

The object contains the

executeRecaptcha

You are recommended to use the custom hook

useGoogleReCaptcha

import {
  GoogleReCaptchaProvider,
  withGoogleReCaptcha
} from 'react-google-recaptcha-v3';

class ReCaptchaComponent extends Component {
  handleVerifyRecaptcha = async () => {
    const { executeRecaptcha } = (this.props as IWithGoogleReCaptchaProps)
      .googleReCaptchaProps;
if (!executeRecaptcha) {
  console.log('Recaptcha has not been loaded');

  return;
}

const token = await executeRecaptcha('homepage');
  };
  render() {
    return (
      

        Verify Recaptcha
      
    );
  }
}

export const WithGoogleRecaptchaExample =
  withGoogleReCaptcha(ReCaptchaComponent);
ReactDom.render(
  
    
  ,
  document.getElementById('app')
);

Example

An example of how to use these two hooks can found inside the

example

RECAPTCHA_KEY=[YOUR_RECAPTCHA_KEY]