useGoogleReCaptcha

useGoogleReCaptcha

Composable for accessing Google reCAPTCHA functionality in Vue applications

const {
  instance,
  isLoading,
  language,
  siteKey,
  executeV3,
  executeV2Invisible,
  reset,
  getResponse,
  render,
} = useGoogleReCaptcha();

Return Value

PropertyTypeDescription
instanceGoogleReCaptcha.Instance | undefinedThe reCAPTCHA instance.
isLoadingbooleanWhether the reCAPTCHA script is still loading.
languagestring | undefinedThe language code used for reCAPTCHA.
siteKeystringThe site key used for reCAPTCHA.
executeV3(action: string) => Promise<string>Executes reCAPTCHA v3 verification. Returns a promise that resolves to the verification token.
executeV2Invisible(optWidgetId?: string) => Promise<void>Executes reCAPTCHA v2 invisible verification.
reset(optWidgetId?: string) => voidResets the reCAPTCHA widget.
getResponse(optWidgetId?: string) => stringGets the current reCAPTCHA response token.
render(container: string | HTMLElement, parameters?: GoogleReCaptcha.Parameters, inherit?: boolean) => numberRenders the reCAPTCHA widget.

Last updated on

On this page