@hcaptcha/loader

hCaptcha Loader

This is a JavaScript library to easily configure the loading of the hCaptcha JS client SDK with built-in error handling. It also includes a retry mechanism that will attempt to load the hCaptcha script several times in the event if fails to load due to a network or unforeseen issue.

hCaptcha is a drop-replacement for reCAPTCHA that protects user privacy.

Sign up at hCaptcha to get your sitekey today. You need a sitekey to use this library.

• Installation
• Implementation
• Props

Installation

npm install @hcaptcha/loader

Implementation

import { hCaptchaLoader } from '@hcaptcha/loader';

await hCaptchaLoader();

hcaptcha.render({
  sitekey: '<your_sitekey>'
});

const { response } = await hcaptcha.execute({ async: true });

Props

Name	Values/Type	Required	Default	Description
loadAsync	Boolean	No	true	Set if the script should be loaded asynchronously.
cleanup	Boolean	No	true	Remove script tag after setup.
crossOrigin	String	No	-	Set script cross origin attribute such as "anonymous".
scriptSource	String	No	https://js.hcaptcha.com/1/api.js	Set script source URI. Takes precedence over secureApi.
scriptLocation	HTMLElement	No	document.head	Location of where to append the script tag. Make sure to add it to an area that will persist to prevent loading multiple times in the same document view.
secureApi	Boolean	No	false	See enterprise docs.
apihost	String	No	-	See enterprise docs.
assethost	String	No	-	See enterprise docs.
endpoint	String	No	-	See enterprise docs.
hl	String	No	-	See enterprise docs.
host	String	No	-	See enterprise docs.
imghost	String	No	-	See enterprise docs.
recaptchacompat	String	No	-	See enterprise docs.
reportapi	String	No	-	See enterprise docs.
sentry	Boolean	No	-	See enterprise docs.
custom	Boolean	No	-	See enterprise docs.