solid-turnstile
v0.0.2
Published
🔐 A very simple Solid library for Cloudflare Turnstile. Inspired by react-turnstile
Downloads
158
Maintainers
Readme
solid-turnstile
🔐 A very simple Solid library for Cloudflare Turnstile. Inspired by react-turnstile
Installation
pnpm add solid-turnstile
Demo
https://xhofe.github.io/solid-turnstile/
Usage
import Turnstile from "react-turnstile";
function TurnstileWidget() {
return (
<Turnstile
sitekey="1x00000000000000000000AA"
onVerify={(token) => alert(token)}
/>
);
}
Documentation
Turnstile takes the following arguments:
| name | type | description |
| ----------------- | ------- | --------------------------------------------- |
| sitekey | string | sitekey of your website (REQUIRED) |
| action | string | - |
| cData | string | - |
| theme | string | one of "light", "dark", "auto" |
| tabIndex | number | - |
| responseField | boolean | controls generation of <input />
element * |
| responseFieldName | string | changes the name of <input />
element * |
Add others props to <div />
element.
And the following callbacks:
| name | arguments | description | | -------- | --------- | ------------------------------------------ | | onVerify | token | called when challenge is passed (REQUIRED) | | onLoad | - | called when the widget is loaded | | onError | error | called when an error occurs | | onExpire | - | called when the challenge expires ** |
* responseField and responseFieldName are experimental and not yet documented.
** onExpire
is called when the Turnstile challenge expires without creating a token.
For more details on what each argument does, see the Cloudflare Documentation.