Use the reCAPTCHA element to verify that site visitors are human before allowing them to perform restricted operations such as data submission, login, or accessing private content.
Important: To ensure complete protection, you must include backend authorization as a mandatory step of the CAPTCHA validation lifecycle.
The following outlines a typical CAPTCHA validation lifecycle:
Getting Started
Videos
Examples
Forumtoken is generated. The onVerified() event indicates a successful CAPTCHA challenge completion. Use the onVerified() event handler to enable the disabled clickable element.onError() event handler to instruct the visitor to try again later. Return to Step 1.authorize() with the generated token.onTimeout() event handler to disable the clickable trigger. Return to Step 1.authorize() checks whether the token is valid. One of the following occurs:
For more information on working with your reCAPTCHA element, click here.
insert() or save()).PROPERTIES
FUNCTIONS
collapsed property to true.collapsed property to false.Hides the element and sets its hidden property
to true, using an effect if specified.
Adds an event handler that runs when the mouse pointer is moved onto the element.
Adds an event handler that runs when the mouse pointer is moved off of the element.
Adds an event handler that runs when an element is displayed in the viewable part of the current window.
Adds an event handler that runs when an element is no longer displayed in the viewable part of the current window.
Shows the element and sets its hidden property
to false, using an effect if specified.
If collapsed is true, the element is not displayed on the page under
any circumstances. A collapsed element, unlike a
hidden element, does not take up any
space on the page. When collapsed, elements positioned within 70 pixels
below the collapsed element and each other move up to take the
collapsed element's place where possible. The elements that move up
maintain their positions relative to one another.
If collapsed is false, the element may be displayed on the page.
Elements that moved up to take the collapsed element's place on the
page are moved back down.
However, an expanded element (an element whose collapsed property is
false) is still not displayed if:
Even if the element is not be displayed due to the conditions
mentioned above, if its collapsed property is false, it's
displayed when the conditions no longer apply.
To set the collapsed property on an element, use the element's
collapse() and expand() functions.
If you select Collapsed on load in the element's Properties panel
in the Editor, the collapsed property is set to true when the page loads.
get collapsed(): boolean
let isCollapsed = $w("#myElement").collapsed; // falseif( $w("#myElement").collapsed ) {
$w("#myElement").expand();
}
else {
$w("#myElement").collapse();
}If global is true, the element appears on all pages.
If global is false, the element only appears on the current page.
get global(): boolean
let isGlobal = $w("#myElement").global; // falseIf hidden is true, the element is not displayed on the page under
any circumstances. A hidden element, unlike a
collapsed element, continues to
take up the same space on the page as it did when it was visible.
If hidden is false, the element may be displayed on the page.
However, an element whose hidden property is false is still not
displayed if:
Even if the element is not displayed due to the conditions
mentioned above, if its hidden property is set to false, it's
displayed when the conditions no longer apply.
To determine if the element is actually visible, use the
isVisible property.
To set the hidden property on an element, use the element's
hide() or show() functions.
If you select Hidden on load in the element's Properties panel
in the Editor, the hidden property is set to true when the page loads.
An element's hidden property is not the same as its
isVisible property. The hidden property
indicates whether the element should be displayed, while isVisible
indicates if it is actually displayed.
hide( ), show( ), collapse( ), expand( ), collapsed, rendered
get hidden(): boolean
let isHidden = $w("#myElement").hidden; // falseif( $w("#myElement").hidden ) {
$w("#myElement").show();
}
else {
$w("#myElement").hide();
}The ID is the element's unique identifier. It is used when selecting
elements using the $w() function.
An element's id is set in the Editor using the Properties panel.
get id(): string
let myId = $w("#myElement").id; // "myElement"If isVisible is true, the element is displayed on the page.
If isVisible is false, the element is not displayed on the page.
The value of the isVisible property is calculated based on the
hidden, collapsed, and rendered
properties of the element and all of its ancestors. It is true
only if the conditions exist in the element's property values and the
property values of its ancestors such that the element is actually
displayed on the page.
An element's isVisible property is not the same as its
hidden property. The isVisible property
indicates whether the element is actually displayed, while hidden
indicates if it should be displayed.
The isVisible property of an element remains true even if
another element completely covers it so that a user cannot see it.
get isVisible(): boolean
let isVisible = $w("#myElement").isVisible; // trueget parent(): Node
let parentElement = $w("#myElement").parent;
let parentId = parentElement.id; // "page1"get rendered(): boolean
let isRendered = $w("#myElement").rendered; // trueWhen a site visitor successfully completes a CAPTCHA challenge, a token
is generated. The token is used for backend authorization.
Prior to completing the CAPTCHA challenge and following timeout, the token returns undefined.
get token(): string
let myToken = $w("#myCaptcha").token;
// "1ABCDeFG23hijKlmn4...OPQ5r6stuvWXy"This example demonstrates how to use reCAPTCHA to protect a data insertion. We use a text input for the data, a reCAPTCHA element, and a submit button. The submit button is disabled until the CAPTCHA is verified and a token is generated. Clicking the submit button triggers backend authorization of the token. If authorization is successful, the data is inserted into the collection.
/************************************
* backend code - submitHandler.jsw *
************************************/
import wixCaptcha from 'wix-captcha-backend';
import wixData from 'wix-data';
// Authorize token and insert data
export function processSubmission(submitRequestData) {
return wixCaptcha.authorize(submitRequestData.token)
.then( () => {
return wixData.insert("MyCollection", submitRequestData.data)
.then( () => ({"type": "success"}))
.catch( (error) => ({"type": "insertion error", "message": "Error: collection insertion failed: " + error}));
})
.catch( (error) => ({"type": "authorization error", "message": "Error: reCAPTCHA authorization failed: " + error}));
}
/********************
* client-side code *
********************/
import {processSubmission} from 'backend/submitHandler';
$w.onReady(function () {
// When user clicks submit button
$w("#submitDataButton").onClick(() => {
let submitRequestData = {
token: $w("#myCaptcha").token,
data: $w("#myInput").value,
}
processSubmission(submitRequestData) // Call backend function
.then( (response) => {
// Display a different message depending on response from backend function
switch(response.type){
case "success":
$w("#messageText").text = "Data successfully submitted";
break;
case "authorization error":
$w("#messageText").text = "CAPTCHA authorization failed. Redo the CAPTCHA challenge.";
break;
case "insertion error":
$w("#messageText").text = "Database error. Redo the CAPTCHA challenge.";
break;
}
$w("#myCaptcha").reset();
$w("#submitDataButton").disable();
$w("#messageText").show();
});
});
// Error handler
$w("#myCaptcha").onError(() => {
$w("#messageText").text = "The reCAPTCHA element lost connection with the CAPTCHA provider. Try again later.";
$w("#messageText").show()
.then(() => {
$w("#messageText").hide("fade", {"delay": 10000});
} );
})
// Verification handler
$w("#myCaptcha").onVerified(() => {
$w("#submitDataButton").enable();
$w("#messageText").hide();
})
// Timeout handler
$w("#myCaptcha").onTimeout(() => {
$w("#submitDataButton").disable();
$w("#messageText").text = "The CAPTCHA has timed out. Please redo the CAPTCHA challenge.";
$w("#messageText").show();
});
});
let myType = $w("#myElement").type; // "$w.Type"The blur() function removes focus from the element and fires a blur
event.
The blur event handlers set on this element by the onBlur( )
function or in the Editor are called.
Removing focus through a call to this function is equivalent to a user clicking on another element or tabbing out of the element manually.
If blur() is called on an element that is not in focus, it has no effect.
The element in focus remains in focus and the onBlur event handlers
are not called.
function blur(): void$w("#myElement").blur();collapsed property to true.function collapse(): Promise<void>collapsed property has been set to true.$w("#myElement").collapse();$w("#myElement").collapse()
.then( () => {
console.log("Done with collapse");
} );if( $w("#myElement").collapsed ) {
$w("#myElement").expand();
}
else {
$w("#myElement").collapse();
}collapsed property to false.function expand(): Promise<void>collapsed property has been set to false.$w("#myElement").expand();$w("#myElement").expand()
.then( () => {
console.log("Done with expand");
} );if( $w("#myElement").collapsed ) {
$w("#myElement").expand();
}
else {
$w("#myElement").collapse();
}The focus() function places focus on the element and fires a focus
event.
The focus event handlers set on this element by the onFocus( )
function or in the Editor are called.
Receiving focus through a call to this function is equivalent to a user clicking on or tabbing to the element manually.
function focus(): void$w("#myElement").focus();Hides the element and sets its hidden property
to true, using an effect if specified.
The hide() function hides the element and returns a Promise that is
resolved when the effect is complete and the element's hidden
property has been set to true.
To learn about the behavior of a hidden element,
see the hidden property.
You can optionally apply an effect when hiding the element by providing
an effectName value. You can also customize the effect by providing the
optional effectOptions object.
Effects:
You can also hide an element when the page loads by using the Properties panel in the Editor.
function hide([effectName: string], [effectOptions: ArcEffectOptions | BounceEffectOptions | FadeEffectOptions | FlipEffectOptions | FloatEffectOptions | FlyEffectOptions | FoldEffectOptions | GlideEffectOptions | PuffEffectOptions | RollEffectOptions | SlideEffectOptions | SpinEffectOptions | TurnEffectOptions | ZoomEffectOptions]): Promise<void>The name of the effect to play when hiding the item.
hidden property has been set to true.$w("#myElement").hide();$w("#myElement").hide("fade");let fadeOptions = {
"duration": 2000,
"delay": 1000
};
$w("#myElement").hide("fade", fadeOptions);$w("#myElement").hide("fade")
.then( ( ) => {
console.log("Done with fade");
} );if( $w("#myElement").hidden ) {
$w("#myElement").show();
}
else {
$w("#myElement").hide();
}An element loses focus (blurs) through user actions, such as clicking and tabbing, or programmatically, using the blur( ) function.
onBlur() has no effect when applied to RadioButtonGroup elements.
Deprecation note: The $w parameter of event handlers is being deprecated. To get
a scoped selector for working with elements in repeater items, use the $w.at() function
and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see
here.
function onBlur(handler: EventHandler): Element
callback EventHandler(event: Event, $w: $w): voidThe name of the function or the function expression to run when the element losed focus.
$w("#myElement").onBlur( (event) => {
let targetId = event.target.id; // "myElement"
});The onError() function allows you to perform actions when the reCAPTCHA element on the client side
loses connection with the CAPTCHA provider.
If an error occurs, the reCAPTCHA element automatically resets. You can ask the site visitor to retry the CAPTCHA challenge later.
function onError(handler: ErrorHandler): void
callback ErrorHandler(): voidThe name of the function or the function expression to run when an error occurs.
In this example, the onError() event handler runs, indicating a connection problem. We flash a temporary message instructing site visitors to try complete the challenge later.
$w("#myCaptcha").onError(() => {
$w("#messageText").text = "The reCAPTCHA element lost connection with the CAPTCHA provider. Try again later.";
$w("#messageText").show()
.then(() => {
$w("#messageText").hide("fade", {"delay": 10000});
} );
} );
An element receives focus through user actions, such as clicking and tabbing, or programmatically, using the focus( ) function.
onFocus() has no effect when applied to RadioButtonGroup elements.
Deprecation note: The $w parameter of event handlers is being deprecated. To get
a scoped selector for working with elements in repeater items, use the $w.at() function
and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see
here.
function onFocus(handler: EventHandler): Element
callback EventHandler(event: Event, $w: $w): voidThe name of the function or the function expression to run when the element receives focus.
$w("#myElement").onFocus( (event) => {
let targetId = event.target.id; // "myElement"
});Adds an event handler that runs when the mouse pointer is moved onto the element.
Deprecation note: The $w parameter of event handlers is being deprecated. To get
a scoped selector for working with elements in repeater items, use the $w.at() function
and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see
here.
function onMouseIn(handler: MouseEventHandler): Element
callback MouseEventHandler(event: MouseEvent, $w: $w): voidThe name of the function or the function expression to run when the mouse pointer is moved onto the element.
$w("#myElement").onMouseIn( (event) => {
let clientX = event.clientX; // 362
let clientY = event.clientY; // 244
let offsetX = event.offsetX; // 10
let offsetY = event.offsetY; // 12
let pageX = event.pageX; // 362
let pageY = event.pageY; // 376
let screenX = event.screenX; // 3897
let screenY = event.screenY; // 362
} );Adds an event handler that runs when the mouse pointer is moved off of the element.
Deprecation note: The $w parameter of event handlers is being deprecated. To get
a scoped selector for working with elements in repeater items, use the $w.at() function
and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see
here.
function onMouseOut(handler: MouseEventHandler): Element
callback MouseEventHandler(event: MouseEvent, $w: $w): voidThe name of the function or the function expression to run when the mouse pointer is moved off of the element.
$w("#myElement").onMouseOut( (event) => {
let clientX = event.clientX; // 362
let clientY = event.clientY; // 244
let offsetX = event.offsetX; // 10
let offsetY = event.offsetY; // 12
let pageX = event.pageX; // 362
let pageY = event.pageY; // 376
let screenX = event.screenX; // 3897
let screenY = event.screenY; // 362
} );The onTimeout() function allows you to perform actions when a CAPTCHA timeout occurs.
When a site visitor completes a CAPTCHA challenge, a token is
generated. If 120 seconds pass without backend authorization,
the token expires and onTimeout() is called.
When a timeout occurs, the reCAPTCHA element automatically resets and displays a message asking the site visitor to redo the challenge. If you enabled the clickable element for triggering a restricted operation when the CAPTCHA was verified, disable it.
function onTimeout(handler: TimeoutHandler): void
callback TimeoutHandler(): voidThe name of the function or the function expression to run when a CAPTCHA timeout occurs.
$w("#myCaptcha").onTimeout(() => {
$w("#submitDataButton").disable();
$w("#messageText").text = "The CAPTCHA has timed out. Please redo the CAPTCHA challenge.";
$w("#messageText").show();
} );Once the CAPTCHA challenge has been successfully completed by the user, the onVerified
callback is triggered and a CAPTCHA token is generated.
If the clickable element for triggering the submit or another restricted operation was disabled, enable it.
function onVerified(handler: VerifiedHandler): void
callback VerifiedHandler(): Promise<void>The name of the function or the function expression to run when the CAPTCHA is verified.
$w("#myCaptcha").onVerified(() => {
$w("#signupButton").enable();
let myToken = $w("#myCaptcha").token;
} );This example demonstrates how to use reCAPTCHA to protect a data insertion. We use a text input for the data, a reCAPTCHA element, and a submit button. The submit button is disabled until the CAPTCHA is verified and a token is generated. Clicking the submit button triggers backend authorization of the token. If authorization is successful, the data is inserted into the collection.
/************************************
* backend code - submitHandler.jsw *
************************************/
import wixCaptcha from 'wix-captcha-backend';
import wixData from 'wix-data';
// Authorize token and insert data
export function processSubmission(submitRequestData) {
return wixCaptcha.authorize(submitRequestData.token)
.then( () => {
return wixData.insert("MyCollection", submitRequestData.data)
.then( () => ({"type": "success"}))
.catch( (error) => ({"type": "insertion error", "message": "Error: collection insertion failed: " + error}));
})
.catch( (error) => ({"type": "authorization error", "message": "Error: reCAPTCHA authorization failed: " + error}));
}
/********************
* client-side code *
********************/
import {processSubmission} from 'backend/submitHandler';
$w.onReady(function () {
// When user clicks submit button
$w("#submitDataButton").onClick(() => {
let submitRequestData = {
token: $w("#myCaptcha").token,
data: $w("#myInput").value,
}
processSubmission(submitRequestData) // Call backend function
.then( (response) => {
// Display a different message depending on response from backend function
switch(response.type){
case "success":
$w("#messageText").text = "Data successfully submitted";
break;
case "authorization error":
$w("#messageText").text = "CAPTCHA authorization failed. Redo the CAPTCHA challenge.";
break;
case "insertion error":
$w("#messageText").text = "Database error. Redo the CAPTCHA challenge.";
break;
}
$w("#myCaptcha").reset();
$w("#submitDataButton").disable();
$w("#messageText").show();
});
});
// Error handler
$w("#myCaptcha").onError(() => {
$w("#messageText").text = "The reCAPTCHA element lost connection with the CAPTCHA provider. Try again later.";
$w("#messageText").show()
.then(() => {
$w("#messageText").hide("fade", {"delay": 10000});
} );
})
// Verification handler
$w("#myCaptcha").onVerified(() => {
$w("#submitDataButton").enable();
$w("#messageText").hide();
})
// Timeout handler
$w("#myCaptcha").onTimeout(() => {
$w("#submitDataButton").disable();
$w("#messageText").text = "The CAPTCHA has timed out. Please redo the CAPTCHA challenge.";
$w("#messageText").show();
});
});
Adds an event handler that runs when an element is displayed in the viewable part of the current window.
An element enters the viewport when the page is scrolled to show any
part of the element. An element also enters the viewport if it was
hidden or collapsed
and is then shown or expanded in the viewable part of the current window. onViewportEnter()
is not fired for hidden or collapsed
elements even if they are scrolled into view.
Deprecation note: The $w parameter of event handlers is being deprecated. To get
a scoped selector for working with elements in repeater items, use the $w.at() function
and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see
here.
function onViewportEnter(handler: EventHandler): Element
callback EventHandler(event: Event, $w: $w): voidThe name of the function or the function expression to run when the element enters the viewport.
$w("#myElement").onViewportEnter( (event) => {
let targetId = event.target.id; // "myElement"
});Adds an event handler that runs when an element is no longer displayed in the viewable part of the current window.
An element leaves the viewport when the page is scrolled so that the
element is completely out of view. An element also leaves the viewport
if it was shown or expanded and is then hidden
or collapsed from the viewable part
of the current window. onViewportLeave()
is not fired for hidden or collapsed
elements even if they are scrolled out of view.
Deprecation note: The $w parameter of event handlers is being deprecated. To get
a scoped selector for working with elements in repeater items, use the $w.at() function
and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see
here.
function onViewportLeave(handler: EventHandler): Element
callback EventHandler(event: Event, $w: $w): voidThe name of the function or the function expression to run when the element leaves the viewport.
$w("#myElement").onViewportLeave( (event) => {
let targetId = event.target.id; // "myElement"
});reset() the reCAPTCHA element in the following cases:
function reset(): Promise<void>$w("#myCaptcha").reset();This example demonstrates how to use reCAPTCHA to protect a data insertion. We use a text input for the data, a reCAPTCHA element, and a submit button. The submit button is disabled until the CAPTCHA is verified and a token is generated. Clicking the submit button triggers backend authorization of the token. If authorization is successful, the data is inserted into the collection.
/************************************
* backend code - submitHandler.jsw *
************************************/
import wixCaptcha from 'wix-captcha-backend';
import wixData from 'wix-data';
// Authorize token and insert data
export function processSubmission(submitRequestData) {
return wixCaptcha.authorize(submitRequestData.token)
.then( () => {
return wixData.insert("MyCollection", submitRequestData.data)
.then( () => ({"type": "success"}))
.catch( (error) => ({"type": "insertion error", "message": "Error: collection insertion failed: " + error}));
})
.catch( (error) => ({"type": "authorization error", "message": "Error: reCAPTCHA authorization failed: " + error}));
}
/********************
* client-side code *
********************/
import {processSubmission} from 'backend/submitHandler';
$w.onReady(function () {
// When user clicks submit button
$w("#submitDataButton").onClick(() => {
let submitRequestData = {
token: $w("#myCaptcha").token,
data: $w("#myInput").value,
}
processSubmission(submitRequestData) // Call backend function
.then( (response) => {
// Display a different message depending on response from backend function
switch(response.type){
case "success":
$w("#messageText").text = "Data successfully submitted";
break;
case "authorization error":
$w("#messageText").text = "CAPTCHA authorization failed. Redo the CAPTCHA challenge.";
break;
case "insertion error":
$w("#messageText").text = "Database error. Redo the CAPTCHA challenge.";
break;
}
$w("#myCaptcha").reset();
$w("#submitDataButton").disable();
$w("#messageText").show();
});
});
// Error handler
$w("#myCaptcha").onError(() => {
$w("#messageText").text = "The reCAPTCHA element lost connection with the CAPTCHA provider. Try again later.";
$w("#messageText").show()
.then(() => {
$w("#messageText").hide("fade", {"delay": 10000});
} );
})
// Verification handler
$w("#myCaptcha").onVerified(() => {
$w("#submitDataButton").enable();
$w("#messageText").hide();
})
// Timeout handler
$w("#myCaptcha").onTimeout(() => {
$w("#submitDataButton").disable();
$w("#messageText").text = "The CAPTCHA has timed out. Please redo the CAPTCHA challenge.";
$w("#messageText").show();
});
});
The scrollTo() function returns a Promise that is resolved when the
animated scroll is complete and the element is now in view.
To scroll to a specific location on the page, see the wix-window
scrollTo() function.
Calling the scrollTo() function on an element in a repeated item that
is selected from the global scope causes
an error.
function scrollTo(): Promise<void>$w("#myElement").scrollTo();$w("#myElement").scrollTo()
.then( ( ) => {
console.log("Done with scroll");
} );Shows the element and sets its hidden property
to false, using an effect if specified.
The show() function shows the element and returns a Promise that is
resolved when the effect is complete and the element's hidden
property has been set to false.
You can optionally apply an effect when showing the element by providing
an effectName value. You can also customize the effect by providing the
optional effectOptions object.
Effects:
"arc""bounce""fade""flip""float""fly""fold""glide""puff""roll""slide""spin""turn""zoom"function show([effectName: string], [effectOptions: ArcEffectOptions | BounceEffectOptions | FadeEffectOptions | FlipEffectOptions | FloatEffectOptions | FlyEffectOptions | FoldEffectOptions | GlideEffectOptions | PuffEffectOptions | RollEffectOptions | SlideEffectOptions | SpinEffectOptions | TurnEffectOptions | ZoomEffectOptions]): Promise<void>The name of the effect to play when showing the item.
hidden property has been set to false.$w("#myElement").show();$w("#myElement").show("fade");let fadeOptions = {
"duration": 2000,
"delay": 1000
};
$w("#myElement").show("fade", fadeOptions);$w("#myElement").show("fade")
.then( ( ) => {
console.log("Done with fade");
} );if( $w("#myElement").hidden ) {
$w("#myElement").show();
}
else {
$w("#myElement").hide();
}