cleanups

Author: weaverryan

src/LiveComponent/CHANGELOG.md

@@ -5,16 +5,12 @@
 -   Added `data-live-ignore` attribute. If included in an element, that element
     will not be updated on re-render.
 
--   `ComponentWithFromTrait`: Added `refreshForm()` to rebuild form based
-    on chnaged data
-
 -   `ComponentWithFormTrait`: call `$this->initializeFormValues()` from
     `mount()` if your component has a custom `mount()`.
 
 -   `ComponentWithFormTrait` no longer has a `setForm()` method, just call
     `$this->formView = $form` from `mount()` if you have a custom mount.
     Hopefully that will not be needed soon.
->>>>>>> 2e4a2fa (Adding refreshForm() to ComponentWithFormTrait)
 
 -   The Live Component AJAX endpoints now return HTML in all situations
     instead of JSON.

src/LiveComponent/src/Resources/doc/index.rst

@@ -1070,52 +1070,89 @@ section above) is to add:
     +     data-action="change->live#update"
       >
 
-Resetting the Form in an Action
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Using Actions to Change your Form: CollectionType
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. versionadded:: 2.1
+Have you ever used Symfony's `CollectionType`_? If you want to be able
+to dynamically add or remove embedded forms, you need to write some
+JavaScript. Well, that's true, unless you render your form inside a
+live component.
 
-    The ``refreshForm()`` method was added in LiveComponent 2.1.
+For example, imagine a "Blog Post" form with an embedded "Comment" forms
+via the ``CollectionType``::
 
-Imagine you have a live action that, instead of saving, changes the underlying
-data of your form - e.g. by setting a property to some value. To handle this,
-be sure to (1) call ``$this->submitForm()`` to handle the incoming frontend data
-and (2) call ``$this->refreshForm()`` after finishing::
+    namespace App\Form;
 
-    #[AsLiveComponent('author_with_book_form')]
-    class AuthorWithBookCollectionTypeComponent extends AbstractController
-    {
-        use ComponentWithFormTrait;
-        use DefaultActionTrait;
+    use Symfony\Component\Form\AbstractType;
+    use Symfony\Component\Form\Extension\Core\Type\CollectionType;
+    use Symfony\Component\Form\FormBuilderInterface;
+    use Symfony\Component\OptionsResolver\OptionsResolver;
+    use App\Entity\BlogPost;
 
-        public Author $author;
+    class BlogPostFormType extends AbstractType
+    {
+        public function buildForm(FormBuilderInterface $builder, array $options)
+        {
+            $builder
+                ->add('title', TextType::class)
+                // ...
+                ->add('comments', CollectionType::class, [
+                    'entry_type' => CommentFormType::class,
+                    'allow_add' => true,
+                    'allow_delete' => true,
+                ])
+            ;
+        }
 
-        public function __construct()
+        public function configureOptions(OptionsResolver $resolver)
         {
-            $this->author = new Author();
+            $resolver->setDefaults(['data_class' => BlogPost::class]);
         }
+    }
+
+Now, create a Twig component to render the form::
+
+    namespace App\Twig;
+
+    use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+    use Symfony\Component\Form\FormInterface;
+    use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+    use Symfony\UX\LiveComponent\Attribute\LiveAction;
+    use Symfony\UX\LiveComponent\ComponentWithFormTrait;
+    use Symfony\UX\LiveComponent\DefaultActionTrait;
+    use App\Entity\BlogPost;
+    use App\Entity\Comment;
+    use App\Form\BlogPostFormType;
+
+    #[AsLiveComponent('blog_post_collection_type')]
+    class BlogPostCollectionTypeComponent extends AbstractController
+    {
+        use ComponentWithFormTrait;
+        use DefaultActionTrait;
+
+        #[LiveProp]
+        public BlogPost $post;
 
         protected function instantiateForm(): FormInterface
         {
-            return $this->createForm(AuthorType::class, $this->author);
+            return $this->createForm(BlogPostFormType::class, $this->post);
         }
 
         #[LiveAction]
-        public function addBook()
+        public function addComment()
         {
-            // submit the values, but no further validation
-            $this->submitForm(false, false);
-
-            // Add a Book to the Author
-            // If AuthorType has a CollectionType "books" field, this will
-            // cause a new, embedded form to render
-            $this->author->addBook(new Book());
-
-            // for the form to rebuild with the new data
-            $this->refreshForm();
+            // "formValues" represents the current data in the form
+            // this modifies the form to add an extra comment
+            // the result: another embedded comment form!
+            $this->formValues['comments'][] = [];
         }
     }
 
+Finally, render the form in the component's template like normal, but
+with a live action that points to ``addComment()``:
+
+TODO
+
 Modifying Embedded Properties with the "exposed" Option
 -------------------------------------------------------
 

src/LiveComponent/tests/Fixture/Component/FormWithCollectionTypeComponent.php

@@ -19,7 +19,6 @@
 use Symfony\UX\LiveComponent\DefaultActionTrait;
 use Symfony\UX\LiveComponent\Tests\Fixture\Dto\BlogPost;
 use Symfony\UX\LiveComponent\Tests\Fixture\Dto\Comment;
-use Symfony\UX\LiveComponent\Tests\Fixture\Entity\Entity1;
 use Symfony\UX\LiveComponent\Tests\Fixture\Form\BlogPostFormType;
 
 #[AsLiveComponent('form_with_collection_type')]

src/LiveComponent/tests/Fixture/Entity/Entity1.php

@@ -24,8 +24,4 @@ class Entity1
      * @ORM\Column(type="integer")
      */
     public $id;
-
-    public $name;
-
-    public $description;
 }

src/LiveComponent/tests/Fixture/Kernel.php

@@ -69,7 +69,6 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
         $c->register(Component3::class)->setAutoconfigured(true)->setAutowired(true);
         $c->register(Component6::class)->setAutoconfigured(true)->setAutowired(true);
         $c->register(ComponentWithAttributes::class)->setAutoconfigured(true)->setAutowired(true);
-        $c->register(FormThatResetsComponent::class)->setAutoconfigured(true)->setAutowired(true);
         $c->register(FormWithCollectionTypeComponent::class)->setAutoconfigured(true)->setAutowired(true);
 
         $c->loadFromExtension('framework', [

src/LiveComponent/tests/Functional/Form/ComponentWithFormTest.php

@@ -31,7 +31,7 @@ class ComponentWithFormTest extends KernelTestCase
     use HasBrowser;
     use ResetDatabase;
 
-    public function testRefreshForm(): void
+    public function testFormValuesRebuildAfterFormChanges(): void
     {
         /** @var LiveComponentHydrator $hydrator */
         $hydrator = self::getContainer()->get('ux.live_component.component_hydrator');