Merge pull request #1 from ramirezcgn/inline-badge

Inline badge

Author: ramirezcgn

src/google-recaptcha-provider.tsx

@@ -1,5 +1,6 @@
 import React from 'react';
 import {
+  useRef,
   useMemo,
   useState,
   useEffect,
@@ -18,7 +19,7 @@ enum GoogleRecaptchaError {
 }
 
 interface IGoogleReCaptchaProviderProps {
-  reCaptchaKey?: string;
+  reCaptchaKey: string;
   language?: string;
   useRecaptchaNet?: boolean;
   useEnterprise?: boolean;
@@ -28,6 +29,18 @@ interface IGoogleReCaptchaProviderProps {
     async?: boolean;
     appendTo?: 'head' | 'body';
     id?: string;
+    onLoadCallbackName?: string;
+  };
+  inlineBadgeId?: string | HTMLElement;
+  parameters?: {
+    sitekey?: string;
+    badge?: string;
+    theme?: string;
+    size?: string;
+    tabindex?: number;
+    callback?: () => void;
+    expiredCallback?: () => void;
+    errorCallback?: () => void;
   };
   children: ReactNode;
 }
@@ -53,11 +66,14 @@ export function GoogleReCaptchaProvider({
   useRecaptchaNet = false,
   scriptProps,
   language,
+  inlineBadgeId,
+  parameters = {},
   children
 }: IGoogleReCaptchaProviderProps) {
   const [greCaptchaInstance, setGreCaptchaInstance] = useState<null | {
     execute: Function;
   }>(null);
+  const clientId = useRef<number | string>(reCaptchaKey);
 
   useEffect(() => {
     if (!reCaptchaKey) {
@@ -69,6 +85,22 @@ export function GoogleReCaptchaProvider({
     }
 
     const scriptId = scriptProps?.id || 'google-recaptcha-v3';
+    const onLoadCallbackName = scriptProps?.onLoadCallbackName || 'onRecaptchaLoadCallback';
+
+    ((window as unknown) as {[key: string]: () => void})[onLoadCallbackName] = () => {
+      /* eslint-disable @typescript-eslint/no-explicit-any */
+      const grecaptcha = useEnterprise
+        ? (window as any).grecaptcha.enterprise
+        : (window as any).grecaptcha;
+
+      const params = {
+        badge: 'inline',
+        size: 'invisible',
+        sitekey: reCaptchaKey,
+        ...(parameters || {})
+      };
+      clientId.current = grecaptcha.render(inlineBadgeId, params);
+    };
 
     const onLoad = () => {
       if (!window || !(window as any).grecaptcha) {
@@ -93,7 +125,8 @@ export function GoogleReCaptchaProvider({
     };
 
     injectGoogleReCaptchaScript({
-      reCaptchaKey,
+      render: inlineBadgeId ? 'explicit' : reCaptchaKey,
+      onLoadCallbackName,
       useEnterprise,
       useRecaptchaNet,
       scriptProps,
@@ -115,18 +148,17 @@ export function GoogleReCaptchaProvider({
         );
       }
 
-      const result = await greCaptchaInstance.execute(reCaptchaKey, { action });
-
-      return result;
+      return await greCaptchaInstance.execute(clientId.current, { action });
     },
-    [greCaptchaInstance]
+    [greCaptchaInstance, clientId]
   );
 
   const googleReCaptchaContextValue = useMemo(
     () => ({
-      executeRecaptcha: greCaptchaInstance ? executeRecaptcha : undefined
+      executeRecaptcha: greCaptchaInstance ? executeRecaptcha : undefined,
+      inlineBadgeId,
     }),
-    [executeRecaptcha, greCaptchaInstance]
+    [executeRecaptcha, greCaptchaInstance, inlineBadgeId]
   );
 
   return (

src/utils.ts

@@ -1,5 +1,6 @@
-interface InjectGoogleReCaptchaScriptParams {
-  reCaptchaKey: string;
+interface IInjectGoogleReCaptchaScriptParams {
+  render: string;
+  onLoadCallbackName: string;
   useRecaptchaNet: boolean;
   useEnterprise: boolean;
   onLoad: () => void;
@@ -38,7 +39,7 @@ const generateGoogleRecaptchaSrc = ({
  */
 const cleanGstaticRecaptchaScript = () => {
   const script = document.querySelector(
-    `script[src^='https://www.gstatic.com/recaptcha/releases']`
+    'script[src^="https://www.gstatic.com/recaptcha/releases"]'
   );
 
   if (script) {
@@ -83,7 +84,8 @@ export const cleanGoogleRecaptcha = (scriptId: string) => {
  * @returns
  */
 export const injectGoogleReCaptchaScript = ({
-  reCaptchaKey,
+  render,
+  onLoadCallbackName,
   language,
   onLoad,
   useRecaptchaNet,
@@ -93,9 +95,9 @@ export const injectGoogleReCaptchaScript = ({
     defer = false,
     async = false,
     id = '',
-    appendTo = undefined
+    appendTo
   } = {}
-}: InjectGoogleReCaptchaScriptParams) => {
+}: IInjectGoogleReCaptchaScriptParams) => {
   const scriptId = id || 'google-recaptcha-v3';
 
   // Script has already been injected, just call onLoad and does othing else
@@ -114,7 +116,9 @@ export const injectGoogleReCaptchaScript = ({
   });
   const js = document.createElement('script');
   js.id = scriptId;
-  js.src = `${googleRecaptchaSrc}?render=${reCaptchaKey}${
+  js.src = `${googleRecaptchaSrc}?render=${render}${
+    render === 'explicit' ? `&onload=${onLoadCallbackName}` : ''
+  }${
     language ? `&hl=${language}` : ''
   }`;