search

xhofe / solid-turnstile

🔐 A very simple Solid library for Cloudflare Turnstile.
https://xhofe.github.io/solid-turnstile/
MIT License
4 stars 1 forks source link
cf-turnstile solidjs turnstile validation

readme

solid-turnstile

solid-turnstile

🔐 A very simple Solid library for Cloudflare Turnstile. Inspired by react-turnstile

release npm npm license sponsor

Installation

pnpm add solid-turnstile

Demo

https://xhofe.github.io/solid-turnstile/

Usage

import Turnstile from "solid-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.