reCAPTCHA-v3


A simple and easy to use reCAPTCHA (v3 only) library for the browser. (You may be also interested in wrapper libraries)

Install

With NPM:
``bash
$ npm install mercurial-recaptcha-v3
`

With Yarn:
`bash
$ yarn add mercurial-recaptcha-v3
`

Prerequisites

To use this package you only need a valid site key for your domain, which you can easily get here.

Usage

With promises:
`javascript
import { load } from 'mercurial-recaptcha-v3'

load('').then((recaptcha) => {
recaptcha.execute('').then((token) => {
console.log(token) // Will print the token
})
})
`

With async/await:
`javascript
import { load } from 'recaptcha-v3'

async function asyncFunction() {
const recaptcha = await load('')
const token = await recaptcha.execute('')

console.log(token) // Will also print the token
}
`

Loader options

The loader takes care of loading the reCAPTCHA script from Google.
Therefore the loader offers optional options for additional configuration:

|Name|Description|Type|Default value
|----|-----------|----|-------------
|useRecaptchaNet|Due to limitations in certain countries it's required to use recaptcha.net instead of google.com.|boolean|false
|autoHideBadge|Will automatically hide the reCAPTCHA badge. Warning: The usage is only allowed if you follow the offical guide for hiding the badge from Google (see here)|boolean|false

$3


To use the options just pass an additional object to the load(...) method.
For example:
`javascript
import { load } from 'recaptcha-v3'

load('', {
useRecaptchaNet: true,
autoHideBadge: true
}).then((recaptcha) => {

})
``

Wrapper libraries

Wrapper libraries are available for:
* Vue.js plugin (vue-recaptcha-v3 / npm)