# recaptcha-v3 Latest version **1.11.3** (published 2024-08-08) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install recaptcha-v3 pnpm add recaptcha-v3 yarn add recaptcha-v3 bun add recaptcha-v3 ``` ## Health **Score 35/100 (D)** — status: abandoned. Positive: has types; no vulnerabilities; high maintenance score. Warnings: low downloads; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 1.11.3 | | Published | 2024-08-08 | | First published | 2018-11-07 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 35 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 138 | | Author | AB INNOVISION UG | | Maintainers | wipeair | | Keywords | captcha, recaptcha, recaptcha-v3 | ## Links - npm: https://www.npmjs.com/package/recaptcha-v3 - Repository: https://github.com/AurityLab/recaptcha-v3 - Issues: https://github.com/AurityLab/recaptcha-v3/issues - npm.io page: https://npm.io/package/recaptcha-v3 ## Recent versions - 1.11.3 (latest) — 2024-08-08 - 1.11.2 — 2024-08-08 - 1.11.1 — 2024-08-08 - 1.11.0 — 2024-08-08 - 1.10.0 — 2021-07-16 - 1.9.1 — 2021-04-13 - 1.9.0 — 2021-04-13 - 1.8.0 — 2020-04-02 - 1.7.2 — 2019-11-30 - 1.7.1 — 2019-11-30 - 1.7.0 — 2019-09-30 - 1.6.1 — 2019-09-28 - 1.6.0 — 2019-09-28 - 1.5.0 — 2019-04-28 - 1.4.0 — 2019-02-24 - … 7 more at https://npm.io/package/recaptcha-v3/versions ## README # reCAPTCHA-v3 [![Build](https://github.com/abinnovision/recaptcha-v3/actions/workflows/build.yml/badge.svg?branch=master&event=push)](https://github.com/abinnovision/recaptcha-v3/actions/workflows/build.yml) [![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) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/recaptcha-v3) A simple and easy to use reCAPTCHA (v3 only) library for the browser. (You may be also interested in [wrapper libraries](#wrapper-libraries)) ## Install With NPM: ```bash $ npm install recaptcha-v3 ``` With Yarn: ```bash $ yarn add recaptcha-v3 ``` ## Prerequisites To use this package you only need a valid site key for your domain, which you can easily get [here](https://www.google.com/recaptcha). ## Usage With promises: ```javascript import { load } from '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` | | **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 official guide for hiding the badge from Google ([see here](https://developers.google.com/recaptcha/docs/faq#id-like-to-hide-the-recaptcha-v3-badge-what-is-allowed)) | _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](#explicit-render-parameters) | Object | `{}` | ### Load options usage 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) => { }) ``` ### Explicit render parameters 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 Wrapper libraries are available for: - Vue.js plugin ([vue-recaptcha-v3](https://github.com/AurityLab/vue-recaptcha-v3) / [npm](https://www.npmjs.com/package/vue-recaptcha-v3)) --- _Source: https://npm.io/package/recaptcha-v3 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._