README

Installation

composer require pawsitiwe/sulu-forms-ajax-validation-bundle

Setup

Service Registration

The extension needs to be registered as symfony service.

services:
    Pawsitiwe\Controller\ValidationController:
        arguments:
            $formBuilder: '@sulu_form.builder'
        tags: ['controller.service_arguments']

Bundle Registration

return [
    Pawsitiwe\SuluFormsAjaxValidationBundle::class => ['all' => true],
]

Route Registration

sulu_frontend_validation:
    resource: '@SuluFormsAjaxValidationBundle/Resources/config/routes.yaml'
    prefix: /

Usage

The route /ajax/form/validate returns the form validation as JSON

Twig Integration

Include the AJAX-enabled form in your templates using the provided partial:

{% include '@SuluFormsAjaxValidation/forms/partials/ajax_form.html.twig' with {
    form: content.form,
    successText: view.form.entity.successText,
    errorText: 'Custom error message' # optional
} %}

This partial automatically:

Uses the custom form theme ajax_form.html.twig
Displays error and success messages
Adds type-specific and additional CSS classes for styling

Example Response

{
    "message": "",
    "valid": false,
    "fields": [
        {
            "id": "dynamic_form1_email",
            "valid": false,
            "modified": true,
            "violation": {
                "message": "This value should not be blank."
            }
        },
        {
            "id": "dynamic_form1_lastName",
            "valid": true,
            "modified": false
        }
    ]
}

Notes

The form parameter must be a Sulu Form object.
successText is optional; if empty, the default translation ajax_form.success will be used.
errorText is optional; if empty, the default translation ajax_form.error will be used.

pawsitiwe / sulu-forms-ajax-validation-bundle

Maintainers

Details