react-google-recaptcha-newrow

React Component Wrapper for Google reCAPTCHA forked by _newrow

Usage no npm install needed!

<script type="module">
  import reactGoogleRecaptchaNewrow from 'https://cdn.skypack.dev/react-google-recaptcha-newrow';
</script>

README

react-google-recaptcha-newrow

Component wrapper for Google reCAPTCHA v2 reverted to version 0.8.1.

DON'T USE THIS UNLESS YOU MUST USE VERSION 0.8.1 OF THE ORIGINAL PACKAGE AND YOUR HAVING THIS BUG:

https://github.com/dozoisch/react-google-recaptcha/issues/76

Also we've added support to load recaptcha from recaptcha.net, we've added the needed documentation in the advanced usage.

THIS DOCUMENTATION IS THE ORIGINAL v0.8.1 VERSION DOCUMENTATION WITH OUR CHANGE TO SUPPORT 'recaptcha.net', SO IF YOU DO DECIDE FOR SOME STRANGE REASON TO USE THIS, FOLLOW IT

Installation

npm install --save react-google-recaptcha-newrow react-async-script

React 0.13

With 0.13, install version 0.4.1

npm install --save react-google-recaptcha@0.4.1

Usage

All you need to do is sign up for an API key pair. You will need the client key.

You can then use the reCAPTCHA. The default require, imports a wrapped component that loads the reCAPTCHA script asynchronously.

var React = require("react");
var render = require("react-dom").render
var ReCAPTCHA = require("react-google-recaptcha");

function onChange(value) {
  console.log("Captcha value:", value);
}

render(
  <ReCAPTCHA
    ref="recaptcha"
    sitekey="Your client site key"
    onChange={onChange}
  />,
  document.body
);

Rendering Props

Other properties can be used to customised the rendering.

Name Type Description
sitekey string The API client key
onChange func The function to be called when the user completes successfully the captcha
theme enum optional light or dark The them of the widget (defaults: light)
type enum optional image or audio The type of initial captcha (defaults: image)
tabindex number optional The tabindex on the element (default: 0)
onExpired func optional callback when the challenge is expired and has to be redone by user. By default it will call the onChange with null to signify expired callback.
stoken string optional set the stoken parameter, which allows the captcha to be used from different domains, see reCAPTCHA secure-token
size enum optional compact, normal or invisible. This allows you to change the size or do an invisible captcha
badge enum optional bottomright, bottomleft or inline. Positions reCAPTCHA badge

In order to translate the reCaptcha widget you should create a global variable configuring the desire language, if you don't provide it reCaptcha will pick up the user's interface language.

window.recaptchaOptions = {
  lang: 'fr'
}

Not from original docs:

In order to load reCaptcha from recaptcha.net (for cases google.com is unavailable), add the following flag, just like in the language example.

window.recaptchaOptions = {
  lang: 'fr',
  useRecaptchaNet: true
}

Component API

The component also has some utility functions that can be called.

  • getValue() returns the value of the captcha field
  • reset() forces reset. See the JavaScript API doc

Invisible reCAPTCHA

Invisible reCAPTCHA

Starting with 0.7.0, the component now supports invisible options. See the reCAPTCHA documentation to see how to configure it.

With the invisible option, you need to handle things a bit differently. You will need to call the execute method by yourself.

var React = require("react");
var render = require("react-dom").render
var ReCAPTCHA = require("react-google-recaptcha");

function onChange(value) {
  console.log("Captcha value:", value);
}

let captcha;

render(
  <form onSubmit={() => { captcha.execute(); }}>
    <ReCAPTCHA
      ref={(el) => { captcha = el; }}
      size="invisible"
      sitekey="Your client site key"
      onChange={onChange}
    />
  </form>,
  document.body
);

Advanced usage

You can also use the barebone components doing the following. Using that component will oblige you to manage the grecaptcha dep and load the script by yourself.

var React = require("react");
var render = require("react-dom").render
var ReCAPTCHA = require("react-google-recaptcha/lib/recaptcha");

var grecaptchaObject = grecaptcha // You must provide access to the google grecaptcha object.

function onChange(value) {
  console.log("Captcha value:", value);
}

render(
  <ReCAPTCHA
    ref="recaptcha"
    sitekey="Your client site key"
    onChange={onChange}
    grecaptcha={grecaptchaObject}
  />,
  document.body
);