Skip to content

Commit 4a667a2

Browse files
doc(readme): order common props + add asyncScriptOnLoad definition
1 parent 5fbf9c3 commit 4a667a2

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,18 @@ Properties used to customise the rendering:
4141

4242
| Name | Type | Description |
4343
|:---- | ---- | ------ |
44-
| sitekey | string | The API client key |
44+
| asyncScriptOnLoad | func | *optional* callback when the google recaptcha script has been loaded |
45+
| badge | enum | *optional* `bottomright`, `bottomleft` or `inline`. Positions reCAPTCHA badge. *Only for invisible reCAPTCHA* |
46+
| hl | string | *optional* set the hl parameter, which allows the captcha to be used from different languages, see [reCAPTCHA hl] |
4547
| onChange | func | The function to be called when the user successfully completes the captcha |
46-
| theme | enum | *optional* `light` or `dark` The theme of the widget *(__defaults:__ `light`)*. See [example][docs_theme]
47-
| type | enum | *optional* `image` or `audio` The type of initial captcha *(__defaults:__ `image`)*
48-
| tabindex | number | *optional* The tabindex on the element *(__default:__ `0`)*
49-
| onExpired | func | *optional* callback when the challenge is expired and has to be redone by user. By default it will call the onChange with null to signify expired callback. |
5048
| onErrored | func | *optional* callback when the challenge errored, most likely due to network issues. |
51-
| stoken | string | *optional* set the stoken parameter, which allows the captcha to be used from different domains, see [reCAPTCHA secure-token] |
52-
| hl | string | *optional* set the hl parameter, which allows the captcha to be used from different languages, see [reCAPTCHA hl] |
49+
| onExpired | func | *optional* callback when the challenge is expired and has to be redone by user. By default it will call the onChange with null to signify expired callback. |
50+
| sitekey | string | The API client key |
5351
| size | enum | *optional* `compact`, `normal` or `invisible`. This allows you to change the size or do an invisible captcha |
54-
| badge | enum | *optional* `bottomright`, `bottomleft` or `inline`. Positions reCAPTCHA badge. *Only for invisible reCAPTCHA* |
52+
| stoken | string | *optional* set the stoken parameter, which allows the captcha to be used from different domains, see [reCAPTCHA secure-token] |
53+
| tabindex | number | *optional* The tabindex on the element *(__default:__ `0`)*
54+
| type | enum | *optional* `image` or `audio` The type of initial captcha *(__defaults:__ `image`)*
55+
| theme | enum | *optional* `light` or `dark` The theme of the widget *(__defaults:__ `light`)*. See [example][docs_theme]
5556

5657
### Component Instance API
5758

0 commit comments

Comments
 (0)