Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@henaff/recaptcha-v3
Advanced tools
Readme
A simple and easy to use reCAPTCHA (v3 only) library for the browser. (You may be also interested in wrapper libraries)
This is a fork from AurityLab's package to add possibility to customize the script loading.
With NPM:
$ npm install recaptcha-v3
With Yarn:
$ yarn add recaptcha-v3
To use this package you only need a valid site key for your domain, which you can easily get here.
With promises:
import { load } from 'recaptcha-v3'
load('<site key>').then((recaptcha) => {
recaptcha.execute('<action>').then((token) => {
console.log(token) // Will print the token
})
})
With async/await:
import { load } from 'recaptcha-v3'
async function asyncFunction() {
const recaptcha = await load('<site key>')
const token = await recaptcha.execute('<action>')
console.log(token) // Will also print the token
}
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 |
useEnterprise | Uses the enterprise version of the recaptcha api and handles the differences in the response. | 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 |
renderParameters | Will add the given parameters to the reCAPTCHA script. The given object will be converted into a query string and will then be added to the URL. | Object | {} |
explicitRenderParameters | Will set the parameters to the explicit rendering. See here | Object | {} |
scriptElementAttributes | Will set the given attributes to the reCAPTCHA script tag. | Object | {'recaptcha-v3-script': '', 'defer': ''} |
To use the options just pass an additional object to the load(...)
method.
For example:
import { load } from 'recaptcha-v3'
load('<site key>', {
useRecaptchaNet: true,
autoHideBadge: true
}).then((recaptcha) => {
})
The ReCaptcha widget will be explicity loaded, which means you can add parameters to the rendering process.
Name | Description | Type |
---|---|---|
container | The container if you want to render the inline widget | string or Element |
badge | The positioning for the widget | 'bottomright' or 'bottomleft' or 'inline' |
size | The size of the widget | 'invisible' |
tabindex | The tab index of the widget | number |
Wrapper libraries are available for:
FAQs
[![npm](https://img.shields.io/npm/v/recaptcha-v3.svg)](https://www.npmjs.com/package/recaptcha-v3) [![npm type definitions](https://img.shields.io/npm/types/recaptcha-v3.svg)](https://www.npmjs.com/package/recaptcha-v3) [![Standard](https://img.shields.i
The npm package @henaff/recaptcha-v3 receives a total of 0 weekly downloads. As such, @henaff/recaptcha-v3 popularity was classified as not popular.
We found that @henaff/recaptcha-v3 demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.