README

reCAPTCHA for React Native (Android and iOS)

A reCAPTCHA library for React Native (Android and iOS) that works.

| Normal | Invisible | | - | - | | | |

Install

Install the module

  yarn add react-native-recaptcha-that-works react-native-webview

  npm i -S react-native-recaptcha-that-works react-native-webview

See the react-native-webview Getting Started Guide.

Usage

With JavaScript:

import React, { useRef } from 'react';
import { View, Button } from 'react-native';

import Recaptcha from 'react-native-recaptcha-that-works';

const App = () => {
    const recaptcha = useRef();

    const send = () => {
        console.log('send!');
        this.recaptcha.current.open();
    }

    const onVerify = token => {
        console.log('success!', token);
    }

    const onExpire = () => {
        console.warn('expired!');
    }

    return (
        <View>
            <Recaptcha
                ref={recaptcha}
                siteKey="<your-recaptcha-public-key>"
                baseUrl="http://my.domain.com"
                onVerify={onVerify}
                onExpire={onExpire}
                size="invisible"
            />
            <Button title="Send" onPress={send} />
        </View>
    );
}

Or with TypeScript:

import React, { useRef } from 'react';
import { View, Button } from 'react-native';

import Recaptcha, { RecaptchaHandles } from "react-native-recaptcha-that-works";

// ...

export const Component: React.FC = () => {
    const recaptcha = useRef<RecaptchaHandles>();

    const send = () => {
        console.log('send!');
        recaptcha.current?.open();
    };

    const onVerify = (token: string) => {
        console.log('success!', token);
    };

    const onExpire = () => {
        console.warn('expired!');
    }

    return (
        <View>
            <Recaptcha
                ref={recaptcha}
                siteKey="<your-recaptcha-public-key>"
                baseUrl="http://my.domain.com"
                onVerify={onVerify}
                onExpire={onExpire}
                size="invisible"
            />
            <Button title="Send" onPress={send} />
        </View>
    );
};

For more details, see the Sample Project or try the Online demo.

Props

|Name|Value|Default|Description| |-|-|-|-| |lang|string||Language code.| |siteKey|string||Your sitekey.| |baseUrl|string||The URL (domain) configured in the reCAPTCHA setup. (ex. http://my.domain.com)| |headerComponent|React Element||A component to render on top of Modal.| |size|'invisible', 'normal' or 'compact'|'normal'|The size of the widget.| |theme|'dark' or 'light'|'light'|The color theme of the widget.| |onLoad|function()||A callback function, executed when the reCAPTCHA is ready to use.| |onVerify|function(token)||A callback function, executed when the user submits a successful response. The recaptcha response token is passed to your callback.| |onExpire|function()||A callback function, executed when the reCAPTCHA response expires and the user needs to re-verify.| |onError|function(error)||A callback function, executed when reCAPTCHA encounters an error (usually network connectivity) and cannot continue until connectivity is restored. If you specify a function here, you are responsible for informing the user that they should retry.| |onClose|function()|| A callback function, executed when the Modal is closed.|

Note: If lang is not set, then device language is used.

Methods

Note: If using size="invisible", then challange run automatically when open is called.

reCAPTCHA v2 docs

Contribute

New features, bug fixes and improvements are welcome! For questions and suggestions use the issues.

Licence

The MIT License (MIT)

Copyright (c) 2020 Douglas Nassif Roma Junior

See the full licence file.

Usage no npm install needed!