feature #800 [Live] Adding helper to reset validation state (weaverryan)

This PR was merged into the 2.x branch.

Discussion
----------

[Live] Adding helper to reset validation state

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Tickets       | None
| License       | MIT

Another DX improvement found while using 2.8.

Cheers!

Commits
-------

9a39daa [Live] Adding helper to reset validation state

Author: weaverryan

src/LiveComponent/doc/index.rst

@@ -2030,6 +2030,30 @@ Once a component has been validated, the component will "remember" that
 it has been validated. This means that, if you edit a field and the
 component re-renders, it will be validated again.
 
+Resetting Validation Errors
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to clear validation errors (e.g. so you can reuse the form again),
+you can call the ``resetValidation()`` method::
+
+    // ...
+    class EditUser
+    {
+        // ...
+
+        #[LiveAction]
+        public function save()
+        {
+            // validate, save, etc
+
+            // reset your live props to the original state
+            $this->user = new User();
+            $this->agreeToTerms = false;
+            // clear the validation state
+            $this->resetValidation();
+        }
+    }
+
 Real-Time Validation on Change
 ------------------------------
 

src/LiveComponent/src/ValidatableComponentTrait.php

@@ -152,6 +152,13 @@ public function setComponentValidator(ComponentValidatorInterface $componentVali
         $this->componentValidator = $componentValidator;
     }
 
+    private function resetValidation(): void
+    {
+        $this->isValidated = false;
+        $this->validatedFields = [];
+        $this->validationErrors = null;
+    }
+
     private function getValidator(): ComponentValidatorInterface
     {
         if (!$this->componentValidator) {

src/LiveComponent/tests/Fixtures/Component/ValidatingComponent.php

@@ -5,6 +5,7 @@
 use Symfony\Component\Validator\Constraints\Length;
 use Symfony\Component\Validator\Constraints\NotBlank;
 use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+use Symfony\UX\LiveComponent\Attribute\LiveAction;
 use Symfony\UX\LiveComponent\Attribute\LiveProp;
 use Symfony\UX\LiveComponent\DefaultActionTrait;
 use Symfony\UX\LiveComponent\ValidatableComponentTrait;
@@ -19,4 +20,10 @@ final class ValidatingComponent
     #[NotBlank]
     #[Length(min: 3)]
     public string $name = '';
+
+    #[LiveAction]
+    public function resetValidationAction(): void
+    {
+        $this->resetValidation();
+    }
 }

src/LiveComponent/tests/Functional/ValidatableComponentTraitTest.php

@@ -59,5 +59,15 @@ public function testFormValuesRebuildAfterFormChanges(): void
             ->assertSuccessful()
             ->assertContains('Has Error: yes')
         ;
+
+        $browser
+            ->post('/_components/validating_component/resetValidationAction', [
+                'json' => [
+                    'props' => $dehydratedProps,
+                ],
+            ])
+            ->assertSuccessful()
+            ->assertContains('Has Error: no')
+        ;
     }
 }