Need help with react-google-recaptcha-v3?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

t49tran
147 Stars 33 Forks MIT License 138 Commits 4 Opened issues

Description

Google Recaptcha V3 integration for React

Services available

!
?

Need anything else?

Contributors list

# 12,124
TypeScr...
JavaScr...
serverl...
node
79 commits
# 43,361
reactjs
Redux
react-r...
React
1 commit
# 128,683
HTML
Shell
CSS
Angular
1 commit
# 172,540
yarn
Webpack
CSS
Front e...
1 commit
# 350,786
F#
vscode
lldb
odm
1 commit
# 20,774
Azure
TypeScr...
JavaScr...
release...
1 commit

React Google Recaptcha V3

React library for integrating Google ReCaptcha V3 to your App.

npm package Code style type definition

Install

npm install react-google-recaptcha-v3

Usage

Provide Recaptcha Key

To use

react-google-recaptcha-v3
, you need to create a recaptcha key for your domain, you can get one from here.

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
since is equivalent to the reCAPTCHA v3.

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

Components

GoogleReCaptchaProvider

react-google-recaptcha-v3
provides a
GoogleReCaptchaProvider
provider component that should be used to wrap around your components.

GoogleReCaptchaProvider
's responsibility is to load the necessary reCaptcha script and provide access to reCaptcha to the rest of your application.

You can customize the injected

script
tag with the
scriptProps
prop. This prop allows you to add
async
,
defer
,
nonce
attributes to the script tag. You can also control whether the injected script will be added to the document body or head with
appendTo
attribute. Example can be found belows. The
scriptProps
and its attributes are all optional.

It also provides an optional prop

language
to support different languages that is supported by Google Recaptcha. https://developers.google.com/recaptcha/docs/language

The provider also provide the prop

useRecaptchaNet
to load script from
recaptcha.net
: https://developers.google.com/recaptcha/docs/faq#can-i-use-recaptcha-globally
import { GoogleReCaptchaProvider } from 'react-google-recaptcha-v3';

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

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

GoogleReCaptcha
component, wrapping your component with the HOC
withGoogleReCaptcha
, or using the custom hook
useGoogleReCaptcha
.

GoogleReCaptcha

GoogleRecaptcha
is a react component that can be used in your app to trigger the validation. It provides a prop
onVerify
, which will be called once the verify is done successfully.
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); }} />

); };

withGoogleReCaptcha

GoogleRecaptcha
is a HOC (higher order component) that can be used to integrate reCaptcha validation with your component and trigger the validation programmatically. It inject the wrapped component with
googleReCaptchaProps
object.

The object contains the

executeRecaptcha
function that can be called to validate the user action.
import {
  GoogleReCaptchaProvider,
  withGoogleReCaptcha
} from 'react-google-recaptcha-v3';

class ReCaptchaComponent extends React.Component { async componentDidMount() { const token = await this.props.googleReCaptchaProps.executeRecaptcha('homepage'); }

render() { ... } }

const YourReCaptchaComponent = withGoogleReCaptcha(ReCaptchaComponent);

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

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
over the HOC
withGoogleReCaptcha
.

It's very simple to use the hook:

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

const YourReCaptchaComponent = () => { const { executeRecaptcha } = useGoogleReCaptcha(); const token = executeRecaptcha("login_page");

return (...) }

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

Example

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

example
folder. You will need to provide an .env file if you want to run it on your own machine.
RECAPTCHA_KEY=[YOUR_RECAPTCHA_KEY]

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.