Form Validation with Foundation Abide
The Abide plugin for Zurb Foundation extends native HTML5 form validation. This guide will show you how to implement form validation for your Freeform forms with Abide.
This guide assumes you are running Foundation 6 and have the Abide plugin correctly installed on your web page.
You can implement Foundation Abide validation for your form 1 of 2 ways:
Inside the Form Builder (CP)
You can add the necessary attributes to your forms with the form builder. Follow the instructions below to see how.
1
- Open up an existing form inside Freeform and go to the Form Settings tab (cog/gear icon).
- At the bottom of the settings tab, there's an area called Form tag Attributes. Add
novalidate
in the Attribute column and leave the Value column empty (or specifytrue
). This suppresses default HTML5 browser level validation. Also adddata-abide
in the Attribute column and leave the Value column empty (or specifytrue
). This triggers Abide level validation.Attribute Value novalidate data-abide
2
- For the rest of your fields, add attributes to them in the form builder interace as needed. To add attributes to fields, simply click the field in the middle layout column, and in the right side Property Editor column, you'll see an Input attributes settings area. For example:
- Add
required
to the Attribute column and leave the Value column empty (or specifytrue
) to make the field required.- Merely checking the This field is required checkbox is not sufficient to trigger Abide, as it's intended just for Freeform's own validation.
- You can also add extra validations like
number
oremail
to trigger more complex predefined patterns as seen here. Note that some attributes may have blank values, and that's okay.Attribute Value required pattern email
- Add
3
- Render your form builder-based form in a Twig template as usual.
{{ freeform.form("foundationForm").render() }}
Finished!
At Template Level
You can add the necessary attributes and changes to your forms directly inside your Twig templates with the Freeform form.renderTag()
. Follow the instructions below to see how.
1
- Add the
novalidate
anddata-abide
attributes to your form using therenderTag()
method like this:{% set form = freeform.form("foundationForm", {
formAttributes: { "novalidate": true, "data-abide": true }
}) %}
{{ form.renderTag({}) }}
...
{{ form.renderClosingTag }}
2
- To set field level attributes, you can apply them directly to your form field inputs or
field.render
. Usually it's more convenient to set these inside the Freeform control panel form builder area, but you can still control these at the template level if you want. Your template code might look something like this:{% set form = freeform.form("foundationForm", {
formAttributes: { "novalidate": true, "data-abide": true }
}) %}
{{ form.renderTag({}) }}
{% for row in form %}
<div>
{% for field in row %}
<div>
{% set attr = {} %}
{% if field.required %}
{% set attr = attr|merge({'required':true}) %}
{% endif %}
{% if field.type == 'number' %}
{% set attr = attr|merge({'pattern':'number'}) %}
{% endif %}
{{ field.render({
inputAttributes: attr
}) }}
{% if field.required and field.type == 'number' %}
<span class="form-error">
This field is required and must be numeric.
</span>
{% endif %}
</div>
{% endfor %}
</div>
{% endfor %}
{{ form.renderClosingTag }}
Finished!