Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hCaptcha/react-hcaptcha

hCaptcha Component Library for ReactJS and Preact
https://github.com/hCaptcha/react-hcaptcha

captcha hcaptcha react reactjs

Last synced: about 1 month ago
JSON representation

hCaptcha Component Library for ReactJS and Preact

Awesome Lists containing this project

README 

        
# React hCaptcha Component Library



hCaptcha Component Library for ReactJS.



[hCaptcha](https://www.hcaptcha.com) is a drop-replacement for reCAPTCHA that protects user privacy.



Sign up at [hCaptcha](https://www.hcaptcha.com) to get your sitekey today. **You need a sitekey to use this library.**



*Also compatible with Preact.*



1. [Installation](#installation)

2. [References](#references)

3. [Debugging](#debugging)

4. [Contributing](#contributing)



## Installation



You can install this library via npm with:



```

npm install @hcaptcha/react-hcaptcha --save

```



### Implementation

The two requirements for usage are the `sitekey` [prop](#props) and a `parent component` such as a ``. The component will automatically include and load the

hCaptcha API library and append it to the parent component. This is designed for ease of use with the hCaptcha API!



#### Standard



```js

import HCaptcha from '@hcaptcha/react-hcaptcha';



     handleVerificationSuccess(token, ekey)}

    />



```



#### Programmatic

In the event you want to call the hCaptcha client API directly, you can do so by using the hook `useRef` and waiting for `onLoad` to be called. By waiting for `onLoad` the hCaptcha API will be ready and the hCaptcha client will have been setup. See the following example:



```js

import { useEffect, useRef, useState } from "react";

import HCaptcha from "@hcaptcha/react-hcaptcha";



export default function Form() {

  const [token, setToken] = useState(null);

  const captchaRef = useRef(null);



  const onLoad = () => {

    // this reaches out to the hCaptcha JS API and runs the

    // execute function on it. you can use other functions as

    // documented here:

    // https://docs.hcaptcha.com/configuration#jsapi

    captchaRef.current.execute();

  };



  useEffect(() => {



    if (token)

      console.log(`hCaptcha Token: ${token}`);



  }, [token]);



  return (

    

      

    

  );

}

```



**Typescript Support** \

If you want to reassign the component name, you could consider making a util that imports the component, then re-exports it as a default.



```ts

// utils/captcha.ts

import HCaptcha from '@hcaptcha/react-hcaptcha';

export default HCaptcha;



// MyFormComponent.tsx

import { default as RenamedCaptcha } from '../utils/captcha';



  



```



#### Advanced



In most real-world implementations, you'll probably be using a form library such as [Formik](https://github.com/jaredpalmer/formik) or [React Hook Form](https://github.com/react-hook-form/react-hook-form).



In these instances, you'll most likely want to use `ref` to handle the callbacks as well as handle field-level validation of a `captcha` field. For an example of this, you can view this [CodeSandbox](https://codesandbox.io/s/react-hcaptchaform-example-forked-ngxge?file=/src/Form.jsx).  This `ref` will point to an instance of the [hCaptcha API](https://docs.hcaptcha.com/configuration#jsapi) where can you interact directly with it.



#### Passing in fields like `rqdata` to `execute()`



Passing an object into the `execute(yourObj)` call will send it through to the underlying JS API. This enables support for Enterprise features like `rqdata`. A simple example is below:



```

const {sitekey, rqdata} = props;

const captchaRef = React.useRef(null);



const onLoad = () => {

  const executePayload = {};

  if (rqdata) {

    executePayload['rqdata'] = rqdata;

  }

  captchaRef.current?.execute(executePayload);

};



return ;

```



### References



#### Props



|Name|Values/Type|Required|Default|Description|

|---|---|---|---|---|

|`sitekey`|String|**Yes**|`-`|This is your sitekey, this allows you to load captcha. If you need a sitekey, please visit [hCaptcha](https://www.hcaptcha.com), and sign up to get your sitekey.|

|`size`|String (normal, compact, invisible)|No|`normal`|This specifies the "size" of the component. hCaptcha allows you to decide how big the component will appear on render, this always defaults to normal.|

|`theme`|String (light, dark, contrast) or Object|No|`light`|hCaptcha supports both a light and dark theme. Defaults to light. Takes Object if custom theme is used.|

|`tabindex`|Integer|No|`0`|Set the tabindex of the widget and popup. When appropriate, this can make navigation of your site more intuitive.|

|`languageOverride`|String (ISO 639-2 code)|No|`auto`|hCaptcha auto-detects language via the user's browser. This overrides that to set a default UI language. See [language codes](https://hcaptcha.com/docs/languages).|

|`reCaptchaCompat`|Boolean|No|`true`|Disable drop-in replacement for reCAPTCHA with `false` to prevent hCaptcha from injecting into `window.grecaptcha`.|

|`id`|String|No|`random id`|Manually set the ID of the hCaptcha component. Make sure each hCaptcha component generated on a single page has its own unique ID when using this prop.|

|`apihost`|String|No|`-`|See enterprise docs.|

|`assethost`|String|No|`-`|See enterprise docs.|

|`endpoint`|String|No|`-`|See enterprise docs.|

|`host`|String|No|`-`|See enterprise docs.|

|`imghost`|String|No|`-`|See enterprise docs.|

|`reportapi`|String|No|`-`|See enterprise docs.|

|`sentry`|String|No|`-`|See enterprise docs.|

|`secureApi`|Boolean|No|`-`|See enterprise docs.|

|`scriptSource`|String|No|`-`|See enterprise docs.|

| `cleanup`         | Boolean     | No       | `true`          | Remove script tag after setup.|

|`custom`|Boolean|No|`-`|Custom theme: see enterprise docs.|

|`loadAsync`|Boolean|No|`true`|Set if the script should be loaded asynchronously.|

|`scriptLocation`|Element|No|`document.head`| Location of where to append the script tag. Make sure to add it to an area that will persist to prevent loading multiple times in the same document view. Note: If `null` is provided, the `document.head` will be used.|



#### Events



|Event|Params|Description|

|---|---|---|

|`onError`|`err`|When an error occurs. Component will reset immediately after an error.|

|`onVerify`|`token, eKey`|When challenge is completed. The response `token` and an `eKey` (session id) are passed along.|

|`onExpire`|-|When the current token expires.|

|`onLoad`|-|When the hCaptcha API loads.|

|`onOpen`|-|When the user display of a challenge starts.|

|`onClose`|-|When the user dismisses a challenge.|

|`onChalExpired`|-|When the user display of a challenge times out with no answer.|



#### Methods



|Method|Description|

|---|---|

|`execute()`|Programmatically trigger a challenge request. Additionally, this method can be run asynchronously and returns a promise with the `token` and `eKey` when the challenge is completed.|

|`getRespKey()`|Get the current challenge reference ID|

|`getResponse()`|Get the current challenge response token from completed challenge|

|`resetCaptcha()`|Reset the current challenge|

|`setData()`|See enterprise docs.|



> **Note** \

> Make sure to reset the hCaptcha state when you submit your form by calling the method `.resetCaptcha` on your hCaptcha React Component! Passcodes are one-time use, so if your user submits the same passcode twice then it will be rejected by the server the second time.



Please refer to the demo for examples of basic usage and an invisible hCaptcha.



Alternatively, see [this sandbox code](https://codesandbox.io/s/react-hcaptchaform-example-invisible-f7ekt) for a quick form example of invisible hCaptcha on a form submit button.



Please note that "invisible" simply means that no hCaptcha button will be rendered. Whether a challenge shows up will depend on the sitekey difficulty level. Note to hCaptcha Enterprise ([BotStop](https://www.botstop.com)) users: select "Passive" or "99.9% Passive" modes to get this No-CAPTCHA behavior.



### Debugging



1. #### Invalid hCaptcha Id: 

    This issue generally occurs when the component is re-rendered causing the current `useRef` to become stale, meaning the `ref` being used is no longer available in the DOM.



2. #### Make sure you don't double-import the api.js script

    Importing the JS SDK twice can cause unpredictable behavior, so don't do a direct import separately if you are using react-hcaptcha.



3. #### Make sure you are using `reCaptchaCompat=false` if you have the reCAPTCHA JS loaded on the same page.

    The hCaptcha "compatibility mode" will interfere with reCAPTCHA, as it adds properties with the same name. If for any reason you are running both hCaptcha and reCAPTCHA in parallel (we recommend only running hCaptcha) then please disable our compatibility mode.



4. #### Avoid conflicts with legacy Sentry package usage on react-hcaptcha 1.9.0+

    If you are using Sentry 7.x in your React app, this can conflict with the upstream `hcaptcha-loader` package's Sentry error tracing. You can avoid this issue by setting the `sentry` prop to `false`.



---

### Contributing



#### Scripts



* `npm run start` - will start the demo app with hot reload

* `npm run test` - will test the library: unit tests

* `npm run build` - will build the production version



#### Publishing



To publish a new version, follow the next steps:

1. Bump the version in `package.json`

2. Create a [Github Release](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release) with version from step 1 **without** a prefix such as `v` (e.g. `1.0.3`)

  * `publish` workflow will be triggered which will: build, test and deploy the package to the [npm @hcaptcha/react-hcaptcha](https://www.npmjs.com/package/@hcaptcha/react-hcaptcha).



#### Running locally for development



Please see: [Local Development Notes](https://docs.hcaptcha.com/#localdev).



Summary:



```

sudo echo "127.0.0.1 fakelocal.com" >> /private/etc/hosts

npm start -- --disable-host-check

```



open [http://fakelocal.com:9000](http://fakelocal.com:9000) to start the example.