https://github.com/codeep/react-recaptcha-v3
https://github.com/codeep/react-recaptcha-v3
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codeep/react-recaptcha-v3
- Owner: codeep
- Created: 2018-06-28T07:38:34.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-29T01:20:59.000Z (over 1 year ago)
- Last Synced: 2025-03-29T23:08:56.177Z (10 months ago)
- Language: JavaScript
- Size: 111 KB
- Stars: 78
- Watchers: 5
- Forks: 42
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://www.google.com/recaptcha/admin#v3signup "V3 signup")
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
| Parameters | Type | Default | Required | Description |
|----------------------|---------|-----------|----------|------------------------------|
| your_site_key | string | undefined | true | Corresponds to the site key you get from [here](https://www.google.com/recaptcha/admin#v3signup "V3 signup") |
| callback | func | () => {} | false | Function called when grepcaptcha is correctly loaded |s
### 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 (
this.recaptcha = ref}
sitekey="your_site_key"
action='action_name'
verifyCallback={this.verifyCallback}
/>
Google ReCaptcha with React
1. Add your site key in the ReCaptcha component.
2. Check console to see the token.
);
};
};
export default ExampleComponent;
```
### ReCaptcha props
| Parameters | Type | Default | Required | Description |
|----------------------|---------|-----------|----------|------------------------------|
| sitekey | string | undefined | true | Corresponds to the site key you get from [here](https://www.google.com/recaptcha/admin#v3signup "V3 signup") |
| action | string | undefined | true | Name of the action performed by the reCaptcha, more on that [here](https://developers.google.com/recaptcha/docs/v3#Actions "V3 actions") |
| verifyCallback | func | undefined | false | This 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.
```
```