Skip to content

Commit 73f165e

Browse files
authored
Merge pull request ghostdevv#19 from GingerAdonis/GingerAdonis-patch-1
2 parents f6c9d18 + 0f3d0f3 commit 73f165e

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,21 @@ The only required prop is the `siteKey` which you can get from [adding a site he
2828

2929
## Props
3030

31-
| Prop | Type | Description | Required |
32-
|-----------------|---------------------------------------------|------------------------------------------------------------------------------------------------|----------|
33-
| `siteKey` | `string` | sitekey for your website ||
34-
| `theme` | `'light' \| 'dark' \| 'auto'` | colour theme of the widget (defaults to `auto`) ||
35-
| `size` | `'normal' \| 'compact'` | size of the widget (defaults to `normal`) ||
36-
| `action` | `string` | A string that can be used to differentiate widgets, returned on validation ||
37-
| `cData` | `string` | A string that can attach customer data to a challange, returned on validation ||
38-
| `tabIndex` | `number` | Used for accessibility (defaults to `0`) ||
39-
| `forms` | `boolean` | if true the response token will be a property on the form data (default `true`) ||
40-
| `formsField` | `string` | the `name` of the input which will appear on the form data (default `cf-turnstile-response`) ||
41-
| `retry` | `'auto' \| 'never'` | should the widget automatically retry to obtain a token if it did not succeed (default `auto`) ||
42-
| `retryInterval` | `number` | if `retry` is true, this controls the time between attempts in milliseconds (default `8000`) ||
43-
| `language` | `SupportedLanguage | 'auto'` | the language turnstile should use (default `auto`) ||
44-
| `execution` | `'render' | 'execute'` | controls when to obtain the token of the widget (default `render`) ||
45-
| `appearance` | `'always' | 'execute' | 'interaction-only'` | controls when the widget is visible. (default `always`) ||
31+
| Prop | Type | Description | Required |
32+
|-----------------|-----------------------------------------------|------------------------------------------------------------------------------------------------|----------|
33+
| `siteKey` | `string` | sitekey for your website ||
34+
| `theme` | `'light' \| 'dark' \| 'auto'` | colour theme of the widget (defaults to `auto`) ||
35+
| `size` | `'normal' \| 'compact'` | size of the widget (defaults to `normal`) ||
36+
| `action` | `string` | A string that can be used to differentiate widgets, returned on validation ||
37+
| `cData` | `string` | A string that can attach customer data to a challange, returned on validation ||
38+
| `tabIndex` | `number` | Used for accessibility (defaults to `0`) ||
39+
| `forms` | `boolean` | if true the response token will be a property on the form data (default `true`) ||
40+
| `formsField` | `string` | the `name` of the input which will appear on the form data (default `cf-turnstile-response`) ||
41+
| `retry` | `'auto' \| 'never'` | should the widget automatically retry to obtain a token if it did not succeed (default `auto`) ||
42+
| `retryInterval` | `number` | if `retry` is true, this controls the time between attempts in milliseconds (default `8000`) ||
43+
| `language` | `SupportedLanguage \| 'auto'` | the language turnstile should use (default `auto`) ||
44+
| `execution` | `'render' \| 'execute'` | controls when to obtain the token of the widget (default `render`) ||
45+
| `appearance` | `'always' \| 'execute' \| 'interaction-only'` | controls when the widget is visible. (default `always`) ||
4646

4747
For more information about some of the props and a list of `SupportedLanguage`'s [checkout the Cloudflare Documentation](https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#configurations).
4848

0 commit comments

Comments
 (0)