Bootstrap 4 Form Theme

Warning: You are browsing the documentation for Symfony 4.x, which is no longer maintained.

Read the updated version of this page for Symfony 7.3 (the current stable version).

Symfony provides several ways of integrating Bootstrap into your application. The most straightforward way is to add the required <link> and <script> elements in your templates (usually you only include them in the main layout template which other templates extend from):

1
2
3
4
5
6
7
8
9
{# templates/base.html.twig #}

{# beware that the blocks in your template may be named different #}
{% block head_css %}
    <!-- Copy CSS from https://getbootstrap.com/docs/4.4/getting-started/introduction/#css -->
{% endblock %}
{% block head_js %}
    <!-- Copy JavaScript from https://getbootstrap.com/docs/4.4/getting-started/introduction/#js -->
{% endblock %}

If your application uses modern front-end practices, it's better to use Webpack Encore and follow this tutorial to import Bootstrap's sources into your SCSS and JavaScript files.

The next step is to configure the Symfony application to use Bootstrap 4 styles when rendering forms. If you want to apply them to all forms, define this configuration:

1
2
3
# config/packages/twig.yaml
twig:
    form_themes: ['bootstrap_4_layout.html.twig']

If you prefer to apply the Bootstrap styles on a form to form basis, include the form_theme tag in the templates where those forms are used:

1
2
3
4
5
6
7
8
{# ... #}
{# this tag only applies to the forms defined in this template #}
{% form_theme form 'bootstrap_4_layout.html.twig' %}

{% block body %}
    <h1>User Sign Up:</h1>
    {{ form(form) }}
{% endblock %}

Error Messages

Form errors are rendered inside the <label> element to make sure there is a strong connection between the error and its <input>, as required by the WCAG 2.0 standard. To achieve this, form_errors() is called by form_label() internally. If you call to form_errors() in your template, you'll get the error messages displayed twice.

Tip

Since form errors are rendered inside the <label>, you cannot use CSS :after to append an asterisk to the label, because it would be displayed after the error message. Use the label option instead.

Checkboxes and Radios

For a checkbox/radio field, calling form_label() doesn't render anything. Due to Bootstrap internals, the label is already rendered by form_widget().

File inputs

File inputs are rendered using the Bootstrap "custom-file" class, which hides the name of the selected file. To fix that, use the bs-custom-file-input JavaScript plugin, as recommended by Bootstrap Forms documentation.

Accessibility

The Bootstrap 4 framework has done a good job making it accessible for functional variations like impaired vision and cognitive ability. Symfony has taken this one step further to make sure the form theme complies with the WCAG 2.0 standard.

This does not mean that your entire website automatically complies with the full standard, but it does mean that you have come far in your work to create a design for all users.

Custom Forms

4.4

Support for the switch-custom class was introduced in Symfony 4.4.

Bootstrap 4 has a feature called "`custom forms`_". You can enable that on your Symfony Form RadioType and CheckboxType by adding some classes to the label:

1
2
3
{{ form_row(form.myRadio, {label_attr: {class: 'radio-custom'} }) }}
{{ form_row(form.myCheckbox, {label_attr: {class: 'checkbox-custom'} }) }}
{{ form_row(form.myCheckbox, {label_attr: {class: 'switch-custom'} }) }}
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version