From d44216d01fcfcfee8225b683ddc2a1ea2f8c9b04 Mon Sep 17 00:00:00 2001 From: Aaron Greenberg Date: Thu, 14 Nov 2024 10:04:54 -0800 Subject: [PATCH 1/2] Add some documentation about widget interactivity --- docs/sdk/configuration.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/sdk/configuration.md b/docs/sdk/configuration.md index 4102fbe..2e2f7ad 100644 --- a/docs/sdk/configuration.md +++ b/docs/sdk/configuration.md @@ -30,6 +30,14 @@ Example:
``` +:::info[A note on clicking] + +One possible source of confusion lies in the distinction between a widget solving and completing. The `data-start` attribute (or `startMode` option for the [JavaScript SDK](reference/sdk.createwidgetoptions#properties)) controls when the widget can start **solving** puzzles. + +However, a widget will not reach its **completed** state until the web user clicks the checkbox. In other words, the CAPTCHA response will not yet be available and the form not ready to submit. For legitimate users in the best case scenario, solving will often be finished by the time they fill out the form. But in order for the widget to complete, they will have to check the box. This behavior provides the strongest level of security against bots and spammers. + +::: + ### `data-form-field-name` By default a hidden form field with name `frc-captcha-response` is created. You can change the name of this field by setting this attribute, which can be useful for integrations with certain frameworks and content management systems. From b8a19069b050f11bd1409fede8f9fb010ad8cf14 Mon Sep 17 00:00:00 2001 From: Aaron Greenberg Date: Fri, 15 Nov 2024 09:56:13 -0800 Subject: [PATCH 2/2] Update clicking documentation post-feedback --- docs/sdk/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sdk/configuration.md b/docs/sdk/configuration.md index 2e2f7ad..1db0538 100644 --- a/docs/sdk/configuration.md +++ b/docs/sdk/configuration.md @@ -34,7 +34,7 @@ Example: One possible source of confusion lies in the distinction between a widget solving and completing. The `data-start` attribute (or `startMode` option for the [JavaScript SDK](reference/sdk.createwidgetoptions#properties)) controls when the widget can start **solving** puzzles. -However, a widget will not reach its **completed** state until the web user clicks the checkbox. In other words, the CAPTCHA response will not yet be available and the form not ready to submit. For legitimate users in the best case scenario, solving will often be finished by the time they fill out the form. But in order for the widget to complete, they will have to check the box. This behavior provides the strongest level of security against bots and spammers. +However, a widget will not reach its **completed** state until the user clicks it. At that point, the CAPTCHA response will be available. With a start mode of `auto` or `focus`, the challenges start solving in the background. By the time the user clicks, the CAPTCHA often completes instantly. There will never be tasks like clicking images of traffic lights. A single click is the only required interaction. :::