useGoogleReCaptchaProvider
Composable for managing Google reCAPTCHA provider state in Vue applications
const googleReCaptcha = useGoogleReCaptchaProvider({
type
siteKey
language
scriptProps
isEnterprise
host
theme
explicit
onLoad
onError
});Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | 'v2-checkbox' | 'v2-invisible' | 'v3' | Yes | - | The type of reCAPTCHA to use |
siteKey | string | Yes | - | Your Google reCAPTCHA site key |
language | string | - | - | Language code for the reCAPTCHA widget |
scriptProps | GoogleReCaptcha.Script | - | - | Additional properties for the reCAPTCHA script |
isEnterprise | boolean | - | false | Whether to use reCAPTCHA Enterprise |
host | string | - | - | Custom host for the reCAPTCHA script |
theme | 'light' | 'dark' | - | light | Theme of the reCAPTCHA widget |
explicit | boolean | ExplicitOptions | - | - | Whether to use explicit rendering |
onLoad | (instance: GoogleReCaptcha.Instance) => void | - | - | Callback when reCAPTCHA is loaded |
onError | () => void | - | - | Callback when an error occurs |
Return Value
| Property | Type | Description |
|---|---|---|
instance | GoogleReCaptcha.Instance | undefined | The reCAPTCHA instance. |
isLoading | boolean | Whether the reCAPTCHA script is still loading. |
language | string | undefined | The language code used for reCAPTCHA. |
siteKey | string | The 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) => void | Resets the reCAPTCHA widget. |
getResponse | (optWidgetId?: string) => string | Gets the current reCAPTCHA response token. |
render | (container: string | HTMLElement, parameters?: GoogleReCaptcha.Parameters, inherit?: boolean) => number | Renders the reCAPTCHA widget. |
Last updated on