solid-grecaptcha
Version:
> Package based on [solid-hcaptcha](https://github.com/Vexcited/solid-hcaptcha) using g-recaptcha of google
64 lines (63 loc) • 1.96 kB
TypeScript
export interface ConfigRender {
/**
* Unique ID used for verifying a valid g-recaptcha Client
*/
sitekey: string;
/**
* Sets a predefined theme or takes a custom theming object.
*/
theme?: 'light' | 'dark';
/**
* Size of the rendered checkbox.
* Defaults to "normal".
*/
size?: 'normal' | 'compact';
/**
* Set the tabindex of the checkbox and challenge. When appropriate, this can make navigation of your site more intuitive.
*/
tabindex?: number;
/**
* Callback function on successful captcha response, response token is passed back in function.
*/
callback?: ((response: string) => void);
/**
* Callback function when user's successful response has expired.
*/
'expired-callback'?: (() => void);
/**
* Callback function when greCaptcha has encountered an error.
*/
'error-callback'?: () => void;
}
export interface GCaptchaProps {
/**
* Unique ID used for verifying a valid g-recaptcha Client
*/
siteKey: string;
/**
* Sets a predefined theme or takes a custom theming object.
*/
theme?: 'dark' | 'light';
/**
* Size of the rendered checkbox.
* Defaults to "normal".
*/
size?: 'compact' | 'normal';
/**
* Set the tabindex of the checkbox and challenge. When appropriate, this can make navigation of your site more intuitive.
*/
tabindex?: number;
/**
* Callback function on successful captcha response, response token is passed back in function.
* @param {string} response token returned by recaptcha
*/
onVerify?: (response: string) => void;
/**
* Callback function when greCaptcha has encountered an error.
*/
onError?: () => void;
/**
* Callback function when user's successful response has expired.
*/
onExpire?: () => void;
}