ember-g-recaptcha

Easily integrate Google's reCaptcha in your app as an Ember Component.

Install

Run the following command from inside your ember-cli project:

ember install ember-g-recaptcha

Configure

You need to generate a valid Site Key / Secret Key pair on Google's reCaptcha admin console. Then, you need to set your Site Key in the ENV var on your config/environment.js file, like this:

  var ENV = {
    // ...

    gReCaptcha: {
      jsUrl: 'https://www.google.com/recaptcha/api.js?render=explicit', // default
      siteKey: 'your-recaptcha-site-key'
    }

    // ...
  }

Basic Usage

Add the component to your template like this:

{{g-recaptcha onSuccess=(action "onCaptchaResolved")}}

then in your component or controller 's actions:

  actions: {
    onCaptchaResolved(reCaptchaResponse) {
      this.get('model').set('reCaptchaResponse', reCaptchaResponse);
      // You should then save your model and the server would validate reCaptchaResponse
      // ...
    },
  }

Advanced Usage

Handling Expiration

You know, after some time the reCaptcha response expires; g-recaptcha 's default behavior is to invoke the reset method. But, if you want to perform custom behavior instead (e.g. transitioning to another route) you can pass your custom action via the onExpired property, like this:

{{g-recaptcha onSuccess=(action "onCaptchaResolved")
              onExpired=(action "onCaptchaExpired") }}

then in your component or controller 's actions:

  actions: {
    onCaptchaExpired() {
      // your custom logic here
    },
  }

Triggering Reset

You might want to arbitrarily trigger reCaptcha reset. For example, if your form submission fails for errors on other fields, you might want to force user to solve a new reCaptcha challenge. To do that, first you'll need to grab a reference to g-recaptcha in your template, like this:

{{g-recaptcha onSuccess=(action "onCaptchaResolved")
              ref=(mut gRecaptcha) }}

then you'll be able to invoke resetReCaptcha() method on gRecaptcha property anywhere in your component or controller 's code, like this:

  this.get('gRecaptcha').resetReCaptcha();

Customization

You can pass g-recaptcha the following properties:

theme
type
size
tabIndex
hl

Their meaning is described on this official doc. Also have a look at the dummy app's example templates.

Configuring source JavaScript URL

In some countries, such as China, you may need to customize the source JavaScript URL. Since the google.com domain is blocked in China, you must set the jsUrl in the configuration to use the recaptcha.net. This works outside China as well.

  var ENV = {
    // ...

    gReCaptcha: {
      jsUrl: 'https://recaptcha.net/recaptcha/api.js?render=explicit', // overridden
      siteKey: 'your-recaptcha-site-key'
    }

    // ...
  }

This also requires the backend URL to be set to https://recaptcha.net/recaptcha/api/siteverify. For more information on configuring the jsUrl, see this issue.

License

ember-g-recaptcha is released under the MIT License.

KoleMyers/ember-g-recaptcha