npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ember-g-recaptcha

v2.1.1

Published

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

Downloads

9,750

Readme

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

  • Ember.js v3.24 or above
  • Ember CLI v3.24 or above
  • Node.js v12 or above

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 = {
  // ...
};

ENV['ember-g-recaptcha'] = {
  jsUrl: 'https://www.google.com/recaptcha/api.js', // default
  sitekey: 'your-recaptcha-site-key',
  hl: 'tr', // Ex: Turkish
};

Basic Usage

Add the component to your template like this:

<GRecaptcha @onSuccess={{this.onCaptchaResolved}} />

then in your component or controller 's actions:

  @action
  onCaptchaResolved(reCaptchaResponse) {
    this.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:

<GRecaptcha
  @onSuccess={{this.onCaptchaResolved}}
  @onExpired={{this.onCaptchaExpired}}
/>

then in your component or controller 's actions:

  @action
  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:

<GRecaptcha
  @onRender={{fn (mut this.gRecaptcha)}}
  @onSuccess={{this.onCaptchaResolved}}
/>

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

this.gRecaptcha.reset();

onRender Callback

You might want to pass a callback function that will be called after the reCaptcha renders on the page. This is great for things like loading spinners. To do so, you can do something like this:

<GRecaptcha
  @onRender={{this.onCaptchaRendered}}
  @onSuccess={{this.onCaptchaResolved}}
/>

then in your component or controller 's actions:

  @action
  onCaptchaRendered() {
    // your custom onRender logic
  }

  @action
  onCaptchaResolved() {
    // ...
  }

Skipping real library download

Sometimes you want to have the behavior of a reCAPTCHA but without the burden of injecting the downloaded library into your web page. This is particularly useful during tests.

<GRecaptcha
  @skip={{true}}
  @onSuccess={{this.onCaptchaResolved}}
/>

Using @skip, you have the power to ignore the reCAPTCHA's real validations but still have the ability to call your success callback.

:warning: This does not work with onError and onExpired.

Customization

You can pass g-recaptcha the following properties:

  • sitekey
  • theme
  • size
  • tabindex
  • badge
  • isolated
  • skip*

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

* The skip option is not a official option.

Invisible reCaptcha

Invisible reCaptcha requires different key than classic reCaptcha. You need to register a new key with invisible type. More information

In some cases you may want to use reCaptcha in the invisible mode. The only thing you need do is to add size key to g-recaptcha component with invisible value and create a button with submit type, so you will get something like this:

<GRecaptcha @onSuccess={{this.onCaptchaResolved}} @size='invisible' />

<button {{on 'click' this.submit}} type='button'>Hello</button>

Then in your component you need to define submit method which will execute reCaptcha. For example:

@action
async submit() {
  await window.grecaptcha.execute();
  // Process rest of operations
}

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 = {
  // ...
};

ENV['ember-g-recaptcha'] = {
  jsUrl: 'https://www.google.com/recaptcha/api.js', // default
  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.