Turnstile Field Element

The Turnstile Field Element protects a Tirenoa Form against spam bots with the Turnstile check. Most visitors pass it without doing anything: the check runs in the background and only asks for a click when it is unsure. Every submission is verified on the server before an entry is saved or an email is sent.

It is an alternative to the reCAPTCHA Field and is used in the same way: add it once to the form and the check covers the whole submission. You choose when the widget is visible, its color scheme, its size and its language, so it fits the design and the audience of your form.

In this article: How To Use · Element Options · Tips · Related Elements

How To Use The Turnstile Field Element

First create a site key and a secret key in your Turnstile account and enter them in the Turnstile section of Global Options; the note Set Up Needed Keys In Global Options in the element reminds you of this. Then open your form under Tirenoa > Forms and add the Turnstile Field Element, usually just above the submit button. It has no label or field name, because it collects no answer.

Appearance Mode sets when the widget is shown: Always shows it as soon as the page loads, Interaction Only keeps it hidden unless the visitor has to click. Color Scheme offers Light, Dark or Auto, which follows the visitor’s device setting. Widget Size is Normal (300px), Compact (150px) or Flexible, which fills the width of the form. Language sets the widget’s text, or Auto for the visitor’s browser language. Default always uses the setting from Global Options.

When the form is sent, the Turnstile result is verified on the server. A failed or missing check stops the submission and the visitor sees a message that the Turnstile challenge could not be completed. This also happens if the Turnstile service does not answer, so the form cannot be sent while it is unreachable. The check result itself is removed before saving, so it does not appear in the form entries or in the notification email.

Element Options

The tables below list every option of the element, grouped by the tabs you see when you edit it in the Builder. Many options depend on others, so the edit screen only shows the options that apply to your current choices.

General

Heading Description
Set Up Needed Keys In Global Options Please make sure to set up the needed keys in Turnstile Section of Global Options.
Appearance Mode Choose the Turnstile appearance mode. “Always” will display the widget on page load in any case, while “Interaction Only” will make it visible only when visitor interaction is required.
Color Scheme Choose the Turnstile color scheme.
Widget Size Choose the Turnstile widget size.
Language Choose the Turnstile widget language.
Tab Index Tab index for the form field.
CSS Class Add a class for the form field.
CSS ID Add an ID for the form field.

Tips

  • Add the field only once per form. One check protects the whole form.
  • Enter the keys before you add the element to a live form. Without keys the widget cannot load, and the form cannot be sent because the server still expects a check result.
  • Use Flexible in narrow columns and on forms that are used mostly on phones; the fixed 300px widget can be wider than a small column.
  • The check loads its script from an external server and sends data about the visitor to the Turnstile service. Mention it in your privacy policy and, where required, in your cookie consent.
  • Combine it with the Honeypot Field Element for a second, invisible layer of spam protection that needs no external service.