Skip to content

Commit 6e8d84e

Browse files
committed
update readme
1 parent 4a1fa62 commit 6e8d84e

1 file changed

Lines changed: 18 additions & 9 deletions

File tree

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,18 @@ function TurnstileWidget() {
2929

3030
Turnstile takes the following arguments:
3131

32-
| name | type | description |
33-
| -------- | ------ | ---------------------------------- |
34-
| sitekey | string | sitekey of your website (REQUIRED) |
35-
| action | string | - |
36-
| cData | string | - |
37-
| theme | string | one of "light", "dark", "auto" |
38-
| tabIndex | number |
39-
| id | string | id of the div |
32+
| name | type | description |
33+
| ----------------- | ------- | --------------------------------------------- |
34+
| sitekey | string | sitekey of your website (REQUIRED) |
35+
| action | string | - |
36+
| cData | string | - |
37+
| theme | string | one of "light", "dark", "auto" |
38+
| tabIndex | number | - |
39+
| responseField | boolean | controls generation of `<input />` element \* |
40+
| responseFieldName | string | changes the name of `<input />` element \* |
41+
| id | string | id of the div |
42+
| className | string | passed to the div |
43+
| style | object | passed to the div |
4044

4145
And the following callbacks:
4246

@@ -45,6 +49,11 @@ And the following callbacks:
4549
| onVerify | token | called when challenge is passed (REQUIRED) |
4650
| onLoad | - | called when the widget is loaded |
4751
| onError | error | called when an error occurs |
48-
| onExpire | - | called when the challenge expires |
52+
| onExpire | - | called when the challenge expires \*\* |
53+
54+
55+
\* responseField and responseFieldName are experimental and not yet documented.
56+
57+
\*\* `onExpire` is called when the Turnstile challenge expires without creating a token.
4958

5059
For more details on what each argument does, see the [Cloudflare Documentation](https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#configurations).

0 commit comments

Comments
 (0)