Live Components

LiveProp Data Types

LiveProps must be a value that can be sent to JavaScript. Supported values are scalars (int, float, string, bool, null), arrays (of scalar values), enums, DateTime objects, Doctrine entity objects, DTOs, or array of DTOs.

See hydration for handling more complex data.

Debouncing

If the user types 5 characters really quickly, we don't want to send 5 Ajax requests. Fortunately, live components adds automatic debouncing: it waits for a 150ms pause between typing before sending an Ajax request to re-render. This is built in, so you don't need to think about it. But, you can delay via the debounce modifier:

1

<input data-model="debounce(100)|max">

Lazy Updating on "change" of a Field

Sometimes, you might want a field to re-render only after the user has changed an input and moved to another field. Browsers dispatch a change event in this situation. To re-render when this event happens, use the on(change) modifier:

1

<input data-model="on(change)|max">

Deferring a Re-Render Until Later

Other times, you might want to update the internal value of a property, but wait until later to re-render the component (e.g. until a button is clicked). To do that, use norender modifier:

1

<input data-model="norender|max">

For a form using ComponentWithFormTrait, override the getDataModelValue() method:

1
2
3
4

private function getDataModelValue(): ?string
{
    return 'norender|*';
}

1

{{ form_start(form, {attr: {'data-model': 'norender|*'}}) }}

Now, as you type, the max "model" will be updated in JavaScript, but it won't, yet, make an Ajax call to re-render the component. Whenever the next re-render does happen, the updated max value will be used.

This can be useful along with a button that triggers a render on click:

1
2

<input data-model="norender|coupon">
<button data-action="live#$render">Apply</button>

Forcing a Re-Render Explicitly

In some cases, you might want to force a component re-render explicitly. For example, consider a checkout component that provides a coupon input that must only be used when clicking on the associated "Apply coupon" button:

1
2

<input data-model="norender|coupon">
<button data-action="live#$render">Apply coupon</button>

The norender option on the input ensures that the component won't re-render when this input changes. The live#$render action is a special built-in action that triggers a re-render.

Using name="" instead of data-model

If you're building a form (more on forms later), instead of adding data-model to every field, you can instead rely on the name attribute.

To activate this, you must add a data-model attribute to the <form> element:

1
2
3
4
5
6
7
8
9
10

<div {{ attributes }}>
    <form data-model="*">
        <input
            name="max"
            value="{{ max }}"
        >

        // ...
    </form>
</div>

The * value of data-model is not necessary, but is commonly used. You can also use the normal modifiers, like data-model="on(change)|*" to, for example, only send model updates for the change event of each field inside.

Model Updates don't work when External JavaScript Changes a Field

Suppose you use a JavaScript library that sets the value of a field for you: for example a "date picker" library that hides the native <input data-model="publishAt"> field and sets it behind-the-scenes when the user selects a date.

In this case, the model (e.g. publishAt) will probably not update correctly because JavaScript doesn't trigger the normal change event. To fix this, you'll need to "hook" into the JavaScript library and set the model directly (or trigger a change event on the data-model field). See manually trigger an element change.

Writable Object Properties or Array Keys

By default, the user can't change the properties of an entity LiveProp You can allow this by setting writable to property names that should be writable. This also works as a way to make only some keys of an array writable:

1
2
3
4
5
6
7
8
9
10
11

use App\Entity\Post;

#[AsLiveComponent]
class EditPost
{
    #[LiveProp(writable: ['title', 'content'])]
    public Post $post;

    #[LiveProp(writable: ['allow_markdown'])]
    public array $options = ['allow_markdown' => true, 'allow_html' => false];
}

Now post.title, post.content or options.allow_markdown can be used like normal model names:

1
2
3
4
5
6
7
8
9
10
11
12
13

<div {{ attributes }}>
    <input data-model="post.title">
    <textarea data-model="post.content"></textarea>

    Allow Markdown?
    <input type="checkbox" data-model="options.allow_markdown">

    Preview:
    <div>
        <h3>{{ post.title }}</h3>
        {{ post.content|markdown_to_html }}
    </div>
</div>

Any other properties on the object (or keys on the array) will be read-only.

For arrays, you can set writable: true to allow any key in the array to be changed, added or removed:

1
2
3
4
5
6
7
8
9
10
11

#[AsLiveComponent]
class EditPost
{
    // ...

    #[LiveProp(writable: true)]
    public array $options = ['allow_markdown' => true, 'allow_html' => false];

    #[LiveProp(writable: true)]
    public array $todoItems = ['Train tiger', 'Feed tiger', 'Pet tiger'];
}

Checkboxes, Select Elements Radios & Arrays

Checkboxes can be used to set a boolean or an array of strings:

1
2
3
4
5
6
7
8
9

#[AsLiveComponent]
class EditPost
{
    #[LiveProp(writable: true)]
    public bool $agreeToTerms = false;

    #[LiveProp(writable: true)]
    public array $foods = ['pizza', 'tacos'];
}

In the template, setting a value attribute on the checkbox will set that value on checked. If no value is set, the checkbox will set a boolean value:

1
2
3
4
5

<input type="checkbox" data-model="agreeToTerms">

<input type="checkbox" data-model="foods[]" value="pizza">
<input type="checkbox" data-model="foods[]" value="tacos">
<input type="checkbox" data-model="foods[]" value="sushi">

select and radio elements are a bit easier: use these to either set a single value or an array of values:

1
2
3
4
5
6
7
8
9
10
11

#[AsLiveComponent]
class EditPost
{
    // ...

    #[LiveProp(writable: true)]
    public string $meal = 'lunch';

    #[LiveProp(writable: true)]
    public array $foods = ['pizza', 'tacos'];
}

1
2
3
4
5
6
7
8
9

<input type="radio" data-model="meal" value="breakfast">
<input type="radio" data-model="meal" value="lunch">
<input type="radio" data-model="meal" value="dinner">

<select data-model="foods" multiple>
    <option value="pizza">Pizza</option>
    <option value="tacos">Tacos</option>
    <option value="sushi">Sushi</option>
</select>

LiveProp Date Formats

If you have a writable LiveProp that is some sort of DateTime instance, you can control the format of the model on the frontend with the format option:

1
2

#[LiveProp(writable: true, format: 'Y-m-d')]
public ?\DateTime $publishOn = null;

Now you can bind this to a field on the frontend that uses that same format:

1

<input type="date" data-model="publishOn">

Allowing an Entity to be Changed to Another

What if, instead of changing a property on an entity, you want to allow the user to switch the entity to another? For example:

1
2
3
4
5

<select data-model="post">
    {% for post in posts %}
        <option value="{{ post.id }}">{{ post.title }}</option>
    {% endfor %}
</select>

To make the post property itself writable, use writable: true:

1
2
3
4
5
6
7
8

use App\Entity\Post;

#[AsLiveComponent]
class EditPost
{
    #[LiveProp(writable: true)]
    public Post $post;
}

If you want the user to be able to change the Post and certain properties, use the special LiveProp::IDENTITY constant:

1
2
3
4
5
6
7
8

use App\Entity\Post;

#[AsLiveComponent]
class EditPost
{
    #[LiveProp(writable: [LiveProp::IDENTITY, 'title', 'content'])]
    public Post $post;
}

Note that being able to change the "identity" of an object is something that works only for objects that are dehydrated to a scalar value (like persisted entities, which dehydrate to an id).

Using DTO's on a LiveProp

You can also use a DTO (i.e. data transfer object / any simple class) with LiveProp as long as the property has the correct type:

1
2
3
4
5

class ComponentWithAddressDto
{
    #[LiveProp]
    public AddressDto $addressDto;
}

To work with a collection of DTOs, specify the collection type inside PHPDoc:

1
2
3
4
5
6
7
8

class ComponentWithAddressDto
{
    /**
     * @var AddressDto[]
     */
    #[LiveProp]
    public array $addressDtoCollection;
}

Collection type extraction from the docblock requires the phpdocumentor/reflection-docblock library. Make sure it is installed in you application:

1

$ composer require phpdocumentor/reflection-docblock

Here is how the (de)hydration of DTO objects works:

• All "properties" (public properties or fake properties via getter/setter methods) are read & dehydrated. If a property is settable but not gettable (or vice versa), an error will be thrown.
• The PropertyAccess component is used to get/set the value, which means getter and setter methods are supported, in addition to public properties.
• The DTO cannot have any constructor arguments.

If this solution doesn't fit your need there are two others options to make this work:

Hydrating with the Serializer

To hydrate/dehydrate through Symfony's serializer, use the useSerializerForHydration option:

1
2
3
4
5

class ComponentWithAddressDto
{
    #[LiveProp(useSerializerForHydration: true)]
    public AddressDto $addressDto;
}

You can also set a serializationContext option on the LiveProp.

Hydrating with Methods: hydrateWith & dehydrateWith

You can take full control of the hydration process by setting the hydrateWith and dehydrateWith options on LiveProp:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

class ComponentWithAddressDto
{
    #[LiveProp(hydrateWith: 'hydrateAddress', dehydrateWith: 'dehydrateAddress')]
    public AddressDto $addressDto;

    public function dehydrateAddress(AddressDto $address)
    {
        return [
            'street' => $address->street,
            'city' => $address->city,
            'state' => $address->state,
        ];
    }

    public function hydrateAddress($data): AddressDto
    {
        return new AddressDto($data['street'], $data['city'], $data['state']);
    }
}

Hydration Extensions

If you frequently hydrate/dehydrate the same type of object, you can create a custom hydration extension to make this easier. For example, if you frequently hydrate a custom Food object, a hydration extension might look like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

use App\Model\Food;
use Symfony\UX\LiveComponent\Hydration\HydrationExtensionInterface;

class FoodHydrationExtension implements HydrationExtensionInterface
{
    public function supports(string $className): bool
    {
        return is_subclass_of($className, Food::class);
    }

    public function hydrate(mixed $value, string $className): ?object
    {
        return new Food($value['name'], $value['isCooked']);
    }

    public function dehydrate(object $object): mixed
    {
        return [
            'name' => $object->getName(),
            'isCooked' => $object->isCooked(),
        ];
    }
}

If you're using autoconfiguration, you're done! Otherwise, tag the service with live_component.hydration_extension.

Adding a Stimulus Controller to your Component Root Element

To add a custom Stimulus controller to your root component element:

1

<div {{ attributes.defaults(stimulus_controller('some-custom', { someValue: 'foo' })) }}>

JavaScript Component Hooks

The JavaScript Component object has a number of hooks that you can use to run code during the lifecycle of your component. To hook into the component system from Stimulus:

1
2
3
4
5
6
7
8
9
10
11
12
13

// assets/controllers/some-custom-controller.js
// ...
import { getComponent } from '@symfony/ux-live-component';

export default class extends Controller {
    async initialize() {
        this.component = await getComponent(this.element);

        this.component.on('render:finished', (component) => {
            // do something after the component re-renders
        });
    }
}

The following hooks are available (along with the arguments that are passed):

• connect args (component: Component)
• disconnect args (component: Component)
• render:started args (html: string, response: BackendResponse, controls: { shouldRender: boolean })
• render:finished args (component: Component)
• response:error args (backendResponse: BackendResponse, controls: { displayError: boolean })
• loading.state:started args (element: HTMLElement, request: BackendRequest)
• loading.state:finished args (element: HTMLElement)
• model:set args (model: string, value: any, component: Component)

Adding and Removing Classes or Attributes

Instead of hiding or showing an entire element, you could add or remove a class:

1
2
3
4
5
6
7
8

<!-- add this class when loading -->
<div data-loading="addClass(opacity-50)">...</div>

<!-- remove this class when loading -->
<div data-loading="removeClass(opacity-50)">...</div>

<!-- add multiple classes when loading -->
<div data-loading="addClass(opacity-50 text-muted)">...</div>

Sometimes you may want to add or remove an HTML attribute when loading. That can be accomplished with addAttribute or removeAttribute:

1
2

<!-- add the "disabled" attribute when loading -->
<div data-loading="addAttribute(disabled)">...</div>

You can also combine any number of directives by separating them with a space:

1

<div data-loading="addClass(opacity-50) addAttribute(disabled)">...</div>

Finally, you can add the delay modifier to not trigger the loading changes until loading has taken longer than a certain amount of time:

1
2
3
4
5
6
7
8

<!-- Add class after 200ms of loading -->
<div data-loading="delay|addClass(opacity-50)">...</div>

<!-- Show after 200ms of loading -->
<div data-loading="delay|show">Loading</div>

<!-- Show after 500ms of loading -->
<div data-loading="delay(500)|show">Loading</div>

Targeting Loading for a Specific Action

To only toggle the loading behavior when a specific action is triggered, use the action() modifier with the name of the action - e.g. saveForm():

1
2
3
4

<!-- show only when the "saveForm" action is triggering -->
<span data-loading="action(saveForm)|show">Loading</span>
<!-- multiple modifiers -->
<div data-loading="action(saveForm)|delay|addClass(opacity-50)">...</div>

Targeting Loading When a Specific Model Changes

You can also toggle the loading behavior only if a specific model value was just changed using the model() modifier:

1
2
3
4
5
6
7
8

<input data-model="email" type="email">

<span data-loading="model(email)|show">
    Checking if email is available...
</span>

<!-- multiple modifiers & child properties -->
<span data-loading="model(user.email)|delay|addClass(opacity-50)">...</span>

Actions & Services

One really neat thing about component actions is that they are real Symfony controllers. Internally, they are processed identically to a normal controller method that you would create with a route.

This means that, for example, you can use action autowiring:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

// src/Twig/Components/RandomNumber.php
namespace App\Twig\Components;

// ...
use Psr\Log\LoggerInterface;

class RandomNumber
{
    // ...

    #[LiveAction]
    public function resetMax(LoggerInterface $logger)
    {
        $this->max = 1000;
        $logger->debug('The min/max were reset!');
    }

    // ...
}

Actions & Arguments

You can also pass arguments to your action by adding each as a Stimulus action parameter:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

<form>
    <button
        data-action="live#action"
        data-live-action-param="addItem"

        data-live-id-param="{{ item.id }}"
        data-live-item-name-param="CustomItem"
    >Add Item</button>
</form>

{# or #}

<form>
    <button {{ live_action('addItem', {'id': item.id, 'itemName': 'CustomItem' }) }}>Add Item</button>
</form>

In your component, to allow each argument to be passed, add the #[LiveArg] attribute:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

// src/Twig/Components/ItemList.php
namespace App\Twig\Components;

// ...
use Psr\Log\LoggerInterface;
use Symfony\UX\LiveComponent\Attribute\LiveArg;

class ItemList
{
    // ...
    #[LiveAction]
    public function addItem(#[LiveArg] int $id, #[LiveArg('itemName')] string $name)
    {
        $this->id = $id;
        $this->name = $name;
    }
}

Actions and CSRF Protection

When an action is triggered, a POST request is sent with a custom Accept header. This header is automatically set and validated for you. In other words, you benefit from CSRF protection effortlessly, thanks to the same-origin and CORS policies enforced by browsers.

To ensure this built-in CSRF protection remains effective, pay attention to your CORS headers (e.g. DO NOT use Access-Control-Allow-Origin: *).

In test-mode, the CSRF protection is disabled to make testing easier.

Actions, Redirecting and AbstractController

Sometimes, you may want to redirect after an action is executed (e.g. your action saves a form and then you want to redirect to another page). You can do that by returning a RedirectResponse from your action:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

// src/Twig/Components/RandomNumber.php
namespace App\Twig\Components;

// ...
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class RandomNumber extends AbstractController
{
    // ...

    #[LiveAction]
    public function resetMax()
    {
        // ...

        $this->addFlash('success', 'Max has been reset!');

        return $this->redirectToRoute('app_random_number');
    }

    // ...
}

You probably noticed one interesting trick: to make redirecting easier, the component now extends AbstractController! That is totally allowed, and gives you access to all of your normal controller shortcuts. We even added a flash message!

Rendering an Entire Form in a Component

Suppose you have a PostType form class that's bound to a Post entity and you'd like to render this in a component so that you can get instant validation as the user types:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

namespace App\Form;

use App\Entity\Post;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class PostType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('title')
            ->add('slug')
            ->add('content')
        ;
    }

    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults([
            'data_class' => Post::class,
        ]);
    }
}

Great! In the template for some page (e.g. an "Edit post" page), render a PostForm component that we will create next:

1
2
3
4
5
6
7
8
9
10

{# templates/post/edit.html.twig #}
{% extends 'base.html.twig' %}

{% block body %}
    <h1>Edit Post</h1>

    {{ component('PostForm', {
        initialFormData: post,
    }) }}
{% endblock %}

Ok: time to build that PostForm component! The Live Components package comes with a special trait - ComponentWithFormTrait - to make it easy to deal with forms:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

namespace App\Twig\Components;

use App\Entity\Post;
use App\Form\PostType;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Form\FormInterface;
use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
use Symfony\UX\LiveComponent\Attribute\LiveProp;
use Symfony\UX\LiveComponent\ComponentWithFormTrait;
use Symfony\UX\LiveComponent\DefaultActionTrait;

#[AsLiveComponent]
class PostForm extends AbstractController
{
    use DefaultActionTrait;
    use ComponentWithFormTrait;

    /**
     * The initial data used to create the form.
     */
    #[LiveProp]
    public ?Post $initialFormData = null;

    protected function instantiateForm(): FormInterface
    {
        // we can extend AbstractController to get the normal shortcuts
        return $this->createForm(PostType::class, $this->initialFormData);
    }
}

The trait forces you to create an instantiateForm() method, which is used each time the component is rendered via AJAX. To recreate the same form as the original, we pass in the initialFormData property and set it as a LiveProp.

The template for this component will render the form, which is available as form thanks to the trait:

1
2
3
4
5
6
7
8
9
10

{# templates/components/PostForm.html.twig #}
<div {{ attributes }}>
    {{ form_start(form) }}
        {{ form_row(form.title) }}
        {{ form_row(form.slug) }}
        {{ form_row(form.content) }}

        <button>Save</button>
    {{ form_end(form) }}
</div>

That's it! The result is incredible! As you finish changing each field, the component automatically re-renders - including showing any validation errors for that field! Amazing!

How this works:

1. The ComponentWithFormTrait has a $formValues writable LiveProp containing the value for every field in your form.
2. When the user changes a field, that key in $formValues is updated and an Ajax request is sent to re-render.
3. During that Ajax call, the form is submitted using $formValues, the form re-renders, and the page is updated.

Build the "New Post" Form Component

The previous component can already be used to edit an existing post or create a new post. For a new post, either pass in a new Post object to initialFormData, or omit it entirely to let the initialFormData property default to null:

1
2
3
4

{# templates/post/new.html.twig #}
{# ... #}

{{ component('PostForm') }}

Submitting the Form via a LiveAction

The simplest way to handle your form submit is directly in your component via a LiveAction:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

// ...
use Doctrine\ORM\EntityManagerInterface;
use Symfony\UX\LiveComponent\Attribute\LiveAction;

class PostForm extends AbstractController
{
    // ...

    #[LiveAction]
    public function save(EntityManagerInterface $entityManager)
    {
        // Submit the form! If validation fails, an exception is thrown
        // and the component is automatically re-rendered with the errors
        $this->submitForm();

        /** @var Post $post */
        $post = $this->getForm()->getData();
        $entityManager->persist($post);
        $entityManager->flush();

        $this->addFlash('success', 'Post saved!');

        return $this->redirectToRoute('app_post_show', [
            'id' => $post->getId(),
        ]);
    }
}

Next, tell the form element to use this action:

1
2
3
4
5
6
7
8
9

{# templates/components/PostForm.html.twig #}
{# ... #}

{{ form_start(form, {
    attr: {
        'data-action': 'live#action:prevent',
        'data-live-action-param': 'save'
    }
}) }}

Now, when the form is submitted, it will execute the save() method via Ajax. If the form fails validation, it will re-render with the errors. And if it's successful, it will redirect.

Submitting with a Normal Symfony Controller

If you prefer, you can submit the form via a Symfony controller. To do this, create your controller like normal, including the submit logic:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

// src/Controller/PostController.php
class PostController extends AbstractController
{
    #[Route('/admin/post/{id}/edit', name: 'app_post_edit')]
    public function edit(Request $request, Post $post, EntityManagerInterface $entityManager): Response
    {
        $form = $this->createForm(PostType::class, $post);
        $form->handleRequest($request);

        if ($form->isSubmitted() && $form->isValid()) {
            // save, redirect, etc
        }

        return $this->render('post/edit.html.twig', [
            'post' => $post,
            'form' => $form, // use $form->createView() in Symfony <6.2
        ]);
    }
}

If validation fails, you'll want the live component to render with the form errors instead of creating a fresh form. To do that, pass the form variable into the component:

1
2
3
4
5

{# templates/post/edit.html.twig #}
{{ component('PostForm', {
    initialFormData: post,
    form: form
}) }}

Using Form Data in a LiveAction

Each time an Ajax call is made to re-render the live component the form is automatically submitted using the latest data.

However, there are two important things to know:

1. When a LiveAction is executed, the form has not yet been submitted.
2. The initialFormData property is not updated until after the form is submitted.

If you need to access the latest data in a LiveAction, you can manually submit the form:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

// ...

#[LiveAction]
public function save()
{
    // $this->initialFormData will *not* contain the latest data yet!

    // submit the form
    $this->submitForm();

    // now you can access the latest data
    $post = $this->getForm()->getData();
    // (same as above)
    $post = $this->initialFormData;
}

Dynamically Updating the Form In a LiveAction

When an Ajax call is made to re-render the live component (whether that's due to a model change or a LiveAction), the form is submitted using a $formValues property from ComponentWithFormTrait that contains the latest data from the form.

Sometimes, you need to update something on the form dynamically from a LiveAction. For example, suppose you have a "Generate Title" button that, when clicked, will generate a title based on the content of the post.

To do this, you must update the $this->formValues property directly before the form is submitted:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

// ...

#[LiveAction]
public function generateTitle()
{
    // this works!
    // (the form will be submitted automatically after this method, now with the new title)
    $this->formValues['title'] = '... some auto-generated-title';

    // this would *not* work
    // $this->submitForm();
    // $post = $this->getForm()->getData();
    // $post->setTitle('... some auto-generated-title');
}

This is tricky. The $this->formValues property is an array of the raw form data on the frontend and contains only scalar values (e.g. strings, integers, booleans and arrays). By updating this property, the form will submit as if the user had typed the new title into the form. The form will then be re-rendered with the new data.

1

$this->formValues['author'] = $author->getId();

Why not just update the $post object directly? Once you submit the form, the "form view" (data, errors, etc for the frontend) has already been created. Changing the $post object has no effect. Even modifying $this->initialFormData before submitting the form has no effect: the actual, submitted title would override that.

Form Rendering Problems

For the most part, rendering a form inside a component works beautifully. But there are a few situations when your form may not behave how you want.

A) Text Boxes Removing Trailing Spaces

If you're re-rendering a field on the input event (that's the default event on a field, which is fired each time you type in a text box), then if you type a "space" and pause for a moment, the space will disappear!

This is because Symfony text fields "trim spaces" automatically. When your component re-renders, the space will disappear… as the user is typing! To fix this, either re-render on the change event (which fires after the text box loses focus) or set the trim option of your field to false:

1
2
3
4
5
6
7
8
9

public function buildForm(FormBuilderInterface $builder, array $options)
{
    $builder
        // ...
        ->add('content', TextareaType::class, [
            'trim' => false,
        ])
    ;
}

B) PasswordType loses the password on re-render

If you're using the PasswordType, when the component re-renders, the input will become blank! That's because, by default, the PasswordType does not re-fill the <input type="password"> after a submit.

To fix this, set the always_empty option to false in your form:

1
2
3
4
5
6
7
8
9

public function buildForm(FormBuilderInterface $builder, array $options)
{
    $builder
        // ...
        ->add('plainPassword', PasswordType::class, [
            'always_empty' => false,
        ])
    ;
}

Resetting the Form

After submitting a form via an action, you might want to "reset" the form back to its initial state so you can use it again. Do that by calling resetForm() in your action instead of redirecting:

1
2
3
4
5
6
7

#[LiveAction]
public function save(EntityManagerInterface $entityManager)
{
    // ...

    $this->resetForm();
}

Using Actions to Change your Form: CollectionType

Symfony's CollectionType can be used to embed a collection of embedded forms including allowing the user to dynamically add or remove them. Live components make this all possible while writing zero JavaScript.

For example, imagine a "Blog Post" form with an embedded "Comment" forms via the CollectionType:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

namespace App\Form;

use App\Entity\BlogPost;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\CollectionType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

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,
                'by_reference' => false,
            ])
        ;
    }

    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults(['data_class' => BlogPost::class]);
    }
}

Now, create a Twig component to render the form:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

namespace App\Twig;

use App\Entity\BlogPost;
use App\Entity\Comment;
use App\Form\BlogPostFormType;
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;

#[AsLiveComponent]
class BlogPostCollectionType extends AbstractController
{
    use ComponentWithFormTrait;
    use DefaultActionTrait;

    #[LiveProp]
    public Post $initialFormData;

    protected function instantiateForm(): FormInterface
    {
        return $this->createForm(BlogPostFormType::class, $this->initialFormData);
    }

    #[LiveAction]
    public function addComment()
    {
        // "formValues" represents the current data in the form
        // this modifies the form to add an extra comment
        // the result: another embedded comment form!
        // change "comments" to the name of the field that uses CollectionType
        $this->formValues['comments'][] = [];
    }

    #[LiveAction]
    public function removeComment(#[LiveArg] int $index)
    {
        unset($this->formValues['comments'][$index]);
    }
}

The template for this component has two jobs: (1) render the form like normal and (2) include links that trigger the addComment() and removeComment() actions:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

<div{{ attributes }}>
    {{ form_start(form) }}
        {{ form_row(form.title) }}

        <h3>Comments:</h3>
        {% for key, commentForm in form.comments %}
            <button
                data-action="live#action"
                data-live-action-param="removeComment"
                data-live-index-param="{{ key }}"
                type="button"
            >X</button>

            {{ form_widget(commentForm) }}
        {% endfor %}

        {# avoid an extra label for this field #}
        {% do form.comments.setRendered %}

        <button
            data-action="live#action"
            data-live-action-param="addComment"
            type="button"
        >+ Add Comment</button>

        <button type="submit" >Save</button>
    {{ form_end(form) }}
</div>

Done! Behind the scenes, it works like this:

A) When the user clicks "+ Add Comment", an Ajax request is sent that triggers the addComment() action.

B) addComment() modifies formValues, which you can think of as the raw "POST" data of your form.

C) Still during the Ajax request, the formValues are "submitted" into your form. The new key inside of $this->formValues['comments'] tells the CollectionType that you want a new, embedded form.

D) The form is rendered - now with another embedded form! - and the Ajax call returns with the form (with the new embedded form).

When the user clicks removeComment(), a similar process happens.

Using LiveCollectionType

The LiveCollectionType uses the same method described above, but in a generic way, so it needs even less code. This form type adds an 'Add' and a 'Delete' button for each row by default, which work out of the box thanks to the LiveCollectionTrait.

Let's take the same example as before, a "Blog Post" form with an embedded "Comment" forms via the LiveCollectionType:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

namespace App\Form;

use App\Entity\BlogPost;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\UX\LiveComponent\Form\Type\LiveCollectionType;

class BlogPostFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('title', TextType::class)
            // ...
            ->add('comments', LiveCollectionType::class, [
                'entry_type' => CommentFormType::class,
            ])
        ;
    }

    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults(['data_class' => BlogPost::class]);
    }
}

Now, create a Twig component to render the form:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

namespace App\Twig;

use App\Entity\BlogPost;
use App\Form\BlogPostFormType;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Form\FormInterface;
use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
use Symfony\UX\LiveComponent\Attribute\LiveProp;
use Symfony\UX\LiveComponent\DefaultActionTrait;
use Symfony\UX\LiveComponent\LiveCollectionTrait;

#[AsLiveComponent]
class BlogPostCollectionType extends AbstractController
{
    use LiveCollectionTrait;
    use DefaultActionTrait;

    #[LiveProp]
    public BlogPost $initialFormData;

    protected function instantiateForm(): FormInterface
    {
        return $this->createForm(BlogPostFormType::class, $this->initialFormData);
    }
}

There is no need for a custom template just render the form as usual:

1
2
3

<div {{ attributes }}>
    {{ form(form) }}
</div>

This automatically renders add and delete buttons that are connected to the live component. If you want to customize how the buttons and the collection rows are rendered, you can use Symfony's built-in form theming techniques, but you should note that, the buttons are not part of the form tree.

Here are some examples of these techniques.

If you only want to customize some attributes, the simplest to use the options in the form type:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

// ...
$builder
    // ...
    ->add('comments', LiveCollectionType::class, [
        'entry_type' => CommentFormType::class,
        'label' => false,
        'button_delete_options' => [
            'label' => 'X',
            'attr' => [
                'class' => 'btn btn-outline-danger',
            ],
        ]
    ])
;

Inline rendering:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

<div {{ attributes }}>
    {{ form_start(form) }}
        {{ form_row(form.title) }}

        <h3>Comments:</h3>
        {% for key, commentForm in form.comments %}
            {# render a delete button for every row #}
            {{ form_row(commentForm.vars.button_delete, { label: 'X', attr: { class: 'btn btn-outline-danger' } }) }}

            {# render rest of the comment form #}
            {{ form_row(commentForm, { label: false }) }}
        {% endfor %}

        {# render the add button #}
        {{ form_widget(form.comments.vars.button_add, { label: '+ Add comment', attr: { class: 'btn btn-outline-primary' } }) }}

        {# render rest of the form #}
        {{ form_row(form) }}

        <button type="submit" >Save</button>
    {{ form_end(form) }}
</div>

Override the specific block for comment items:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{% form_theme form 'components/_form_theme_comment_list.html.twig' %}

<div {{ attributes }}>
    {{ form_start(form) }}
        {{ form_row(form.title)

        <h3>Comments:</h3>
        <ul>
            {{ form_row(form.comments, { skip_add_button: true }) }}
        </ul>

        {# render rest of the form #}
        {{ form_row(form) }}

        <button type="submit" >Save</button>
    {{ form_end(form) }}
</div>

1
2
3
4
5
6
7

{# templates/components/_form_theme_comment_list.html.twig #}
{%- block _blog_post_form_comments_entry_row -%}
    <li class="...">
        {{ form_row(form.content, { label: false }) }}
        {{ form_row(button_delete, { label: 'X', attr: { class: 'btn btn-outline-danger' } }) }}
    </li>
{% endblock %}

Override the generic buttons and collection entry:

The add and delete buttons are rendered as separate ButtonType form types and can be customized like a normal form type via the live_collection_button_add and live_collection_button_delete block prefix respectively:

1
2
3
4
5
6
7
8
9
10
11
12

{% block live_collection_button_add_widget %}
    {% set attr = attr|merge({'class': attr.class|default('btn btn-ghost')}) %}
    {% set translation_domain = false %}
    {% set label_html = true %}
    {%- set label -%}
        <svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2">
            <path stroke-linecap="round" stroke-linejoin="round" d="M12 6v6m0 0v6m0-6h6m-6 0H6"/>
        </svg>
        {{ 'form.collection.button.add.label'|trans({}, 'forms') }}
    {%- endset -%}
    {{ block('button_widget') }}
{% endblock live_collection_button_add_widget %}

To control how each row is rendered you can override the blocks related to the LiveCollectionType. This works the same way as the traditional collection type, but you should use live_collection_* and live_collection_entry_* as prefixes instead.

For example, by default the add button is placed after the items (the comments in our case). Let's move it before them.

1
2
3
4
5
6

{%- block live_collection_widget -%}
    {%- if button_add is defined and not button_add.rendered -%}
        {{ form_row(button_add) }}
    {%- endif -%}
    {{ block('form_widget') }}
{%- endblock -%}

Now add a div around each row:

1
2
3
4
5
6
7
8

{%- block live_collection_entry_row -%}
    <div>
        {{ block('form_row') }}
        {%- if button_delete is defined and not button_delete.rendered -%}
            {{ form_row(button_delete) }}
        {%- endif -%}
    </div>
{%- endblock -%}

As another example, let's create a general bootstrap 5 theme for the live collection type, rendering every item in a table row:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

{%- block live_collection_widget -%}
    <table class="table table-borderless form-no-mb">
        <thead>
        <tr>
            {% for child in form|last %}
                <td>{{ form_label(child) }}</td>
            {% endfor %}
            <td></td>
        </tr>
        </thead>
        <tbody>
            {{ block('form_widget') }}
        </tbody>
    </table>
    {%- if skip_add_button|default(false) is same as(false) and button_add is defined and not button_add.rendered -%}
        {{ form_widget(button_add, { label: '+ Add Item', attr: { class: 'btn btn-outline-primary' } }) }}
    {%- endif -%}
{%- endblock -%}

{%- block live_collection_entry_row -%}
    <tr>
        {% for child in form %}
            <td>{{- form_row(child, { label: false }) -}}</td>
        {% endfor %}
        <td>
            {{- form_row(button_delete, { label: 'X', attr: { class: 'btn btn-outline-danger' } }) -}}
        </td>
    </tr>
{%- endblock -%}

To render the add button later in the template, you can skip rendering it initially with skip_add_button, then render it manually after:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

<table class="table table-borderless form-no-mb">
    <thead>
        <tr>
            <td>Item</td>
            <td>Priority</td>
            <td></td>
        </tr>
    </thead>
    <tbody>
        {{ form_row(form.todoItems, { skip_add_button: true }) }}
    </tbody>
</table>

{{ form_widget(form.todoItems.vars.button_add, { label: '+ Add Item', attr: { class: 'btn btn-outline-primary' } }) }}

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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

// ...
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();
    }
}

Loading "defer" (Ajax on Load)

If a component is heavy to render, you can defer rendering it until after the page has loaded. To do this, add a loading="defer" attribute:

1
2

{# With the HTML syntax #}
<twig:SomeHeavyComponent loading="defer" />

1
2

{# With the component function #}
{{ component('SomeHeavyComponent', { loading: 'defer' }) }}

This renders an empty <div> tag, but triggers an Ajax call to render the real component once the page has loaded.

Loading "lazy" (Ajax when Visible)

The lazy option is similar to defer, but it defers the loading of the component until it's in the viewport. This is useful for components that are far down the page and are not needed until the user scrolls to them.

To use this, set a loading="lazy" attribute to your component:

1
2

{# With the HTML syntax #}
<twig:Acme foo="bar" loading="lazy" />

1
2

{# With the Twig syntax #}
{{ component('SomeHeavyComponent', { loading: 'lazy' }) }}

This renders an empty <div> tag. The real component is only rendered when it appears in the viewport.

Defer or Lazy?

The defer and lazy options may seem similar, but they serve different purposes: defer is useful for components that are heavy to render but are required when the page loads. lazy is useful for components that are not needed until the user scrolls to them (and may even never be rendered).

Loading content

You can define some content to be rendered while the component is loading, either inside the component template (the placeholder macro) or from the calling template (the loading-template attribute and the loadingContent block).

In the component template, define a placeholder macro, outside of the component's main content. This macro will be called when the component is deferred:

1
2
3
4
5
6
7
8
9
10
11
12

{# templates/recommended-products.html.twig #}
<div {{ attributes }}>
    {# This will be rendered when the component is fully loaded #}
    {% for product in this.products %}
        <div>{{ product.name }}</div>
    {% endfor %}
</div>

{% macro placeholder(props) %}
    {# This content will (only) be rendered as loading content #}
    <span class="loading-row"></span>
{% endmacro %}

The props argument contains the props passed to the component. You can use it to customize the placeholder content. Let's say your component shows a certain number of products (defined with the size prop). You can use it to define a placeholder that shows the same number of rows:

1
2

{# In the calling template #}
<twig:RecommendedProducts size="3" loading="defer" />

1
2
3
4
5
6
7
8

{# In the component template #}
{% macro placeholder(props) %}
    {% for i in 1..props.size %}
        <div class="loading-product">
            ...
        </div>
    {% endfor %}
{% endmacro %}

To customize the loading content from the calling template, you can use the loading-template option to point to a template:

1
2
3
4
5

{# With the HTML syntax #}
<twig:SomeHeavyComponent loading="defer" loading-template="spinning-wheel.html.twig" />

{# With the component function #}
{{ component('SomeHeavyComponent', { loading: 'defer', 'loading-template': 'spinning-wheel.html.twig' }) }}

Or override the loadingContent block:

1
2
3
4
5
6
7
8
9

{# With the HTML syntax #}
<twig:SomeHeavyComponent loading="defer">
    <twig:block name="loadingContent">Custom Loading Content...</twig:block>
</twig:SomeHeavyComponent>

{# With the component tag #}
{% component SomeHeavyComponent with { loading: 'defer' } %}
    {% block loadingContent %}Loading...{% endblock %}
{% endcomponent %}

When loading-template or loadingContent is defined, the placeholder macro is ignored.

To change the initial tag from a div to something else, use the loading-tag option:

1

{{ component('SomeHeavyComponent', { loading: 'defer', 'loading-tag': 'span' }) }}

Supported Data Types

You can use scalars, arrays and objects in your URL bindings:

When a page is loaded with a query parameter that's bound to a LiveProp (e.g. /search?query=my+search+string), the value - my search string - goes through the hydration system before it's set onto the property. If a value can't be hydrated, it will be ignored.

Multiple Query Parameter Bindings

You can use as many URL bindings as you want in your component. To ensure the state is fully represented in the URL, all bound props will be set as query parameters, even if their values didn't change.

For example, if you declare the following bindings:

1
2
3
4
5
6
7
8
9
10
11
12

// ...
#[AsLiveComponent]
class SearchModule
{
    #[LiveProp(writable: true, url: true)]
    public string $query = '';

    #[LiveProp(writable: true, url: true)]
    public string $mode = 'fulltext';

    // ...
}

And you only set the query value, then your URL will be updated to https://my.domain/search?query=my+query+string&mode=fulltext.

Controlling the Query Parameter Name

Instead of using the prop's field name as the query parameter name, you can use the as option in your LiveProp definition:

1
2
3
4
5
6
7
8
9
10
11

// ...
use Symfony\UX\LiveComponent\Metadata\UrlMapping;

#[AsLiveComponent]
class SearchModule
{
    #[LiveProp(writable: true, url: new UrlMapping(as: 'q'))]
    public string $query = '';

    // ...
}

Then the query value will appear in the URL like https://my.domain/search?q=my+query+string.

If you need to change the parameter name on a specific page, you can leverage the modifier option:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// ...
use Symfony\UX\LiveComponent\Metadata\UrlMapping;

#[AsLiveComponent]
class SearchModule
{
    #[LiveProp(writable: true, url: true, modifier: 'modifyQueryProp')]
    public string $query = '';

    #[LiveProp]
    public ?string $alias = null;

    public function modifyQueryProp(LiveProp $liveProp): LiveProp
    {
        if ($this->alias) {
            $liveProp = $liveProp->withUrl(new UrlMapping(as: $this->alias));
        }
        return $liveProp;
    }
}

1

<twig:SearchModule alias="q" />

This way you can also use the component multiple times in the same page and avoid collisions in parameter names:

1
2

<twig:SearchModule alias="q1" />
<twig:SearchModule alias="q2" />

The modifier function can also take the name of the property as a secondary parameter. It can be used to perform more generic operations inside of the modifier that can be re-used for multiple props:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

abstract class AbstractSearchModule
{
    #[LiveProp(writable: true, url: true, modifier: 'modifyQueryProp')]
    public string $query = '';

    protected string $urlPrefix = '';

    public function modifyQueryProp(LiveProp $liveProp, string $propName): LiveProp
    {
        if ($this->urlPrefix) {
            return $liveProp->withUrl(new UrlMapping(as: $this->urlPrefix.'-'.$propName));
        }
        return $liveProp;
    }
}

#[AsLiveComponent]
class ImportantSearchModule extends AbstractSearchModule
{
}

#[AsLiveComponent]
class SecondarySearchModule extends AbstractSearchModule
{
    protected string $urlPrefix = 'secondary';
}

1
2

<twig:ImportantSearchModule />
<twig:SecondarySearchModule />

The query value will appear in the URL like /search?query=my+important+query&secondary-query=my+secondary+query.

Validating the Query Parameter Values

Like any writable LiveProp, because the user can modify this value, you should consider adding validation. When you bind a LiveProp to the URL, the initial value is not automatically validated. To validate it, you have to set up a PostMount hook:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

// ...
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\UX\LiveComponent\ValidatableComponentTrait;
use Symfony\UX\TwigComponent\Attribute\PostMount;

#[AsLiveComponent]
class SearchModule
{
    use ValidatableComponentTrait;

    #[LiveProp(writable: true, url: true)]
    public string $query = '';

    #[LiveProp(writable: true, url: true)]
    #[Assert\NotBlank]
    public string $mode = 'fulltext';

    #[PostMount]
    public function postMount(): void
    {
        // Validate 'mode' field without throwing an exception, so the component can
        // be mounted anyway and a validation error can be shown to the user
        if (!$this->validateField('mode', false)) {
            // Do something when validation fails
        }
    }

    // ...
}

Emitting an Event

There are three ways to emit an event:

1. From Twig:

   1
   2
   3
   4

   <button
       data-action="live#emit"
       data-live-event-param="productAdded"
   >

2. From your PHP component via ComponentToolsTrait:

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14

   use Symfony\UX\LiveComponent\ComponentToolsTrait;
   
   class MyComponent
   {
       use ComponentToolsTrait;
   
       #[LiveAction]
       public function saveProduct()
       {
           // ...
   
           $this->emit('productAdded');
       }
   }

3. From JavaScript, using your component:

1

this.component.emit('productAdded');

Listen to Events

To listen to an event, add a method with a #[LiveListener] above it:

1
2
3
4
5
6
7
8

#[LiveProp]
public int $productCount = 0;

#[LiveListener('productAdded')]
public function incrementProductCount()
{
    $this->productCount++;
}

Thanks to this, when any other component emits the productAdded event, an Ajax call will be made to call this method and re-render the component.

Behind the scenes, event listeners are also LiveActions <actions>, so you can autowire any services you need.

Passing Data to Listeners

You can also pass extra (scalar) data to the listeners:

1
2
3
4
5
6
7
8
9

#[LiveAction]
public function saveProduct()
{
    // ...

    $this->emit('productAdded', [
        'product' => $product->getId(),
    ]);
}

From a Twig template:

1
2
3
4
5

<button
    data-action="live#emit"
    data-live-event-param="productAdded"
    data-live-product-param="123"
>

In your listeners, you can access this by adding a matching argument name with #[LiveArg] in front:

1
2
3
4
5
6

#[LiveListener('productAdded')]
public function incrementProductCount(#[LiveArg] int $product)
{
    $this->productCount++;
    $this->lastProductId = $product;
}

And because event listeners are also actions, you can type-hint an argument with an entity name, just like you would in a controller:

1
2
3
4
5
6

#[LiveListener('productAdded')]
public function incrementProductCount(#[LiveArg] Product $product)
{
    $this->productCount++;
    $this->lastProduct = $product;
}

Scoping Events

By default, when an event is emitted, it is sent to all components that are currently on the page. You can scope these in various ways:

1
2
3
4

<button
    data-action="live#emitUp"
    data-live-event-param="productAdded"
>

1

$this->emitUp('productAdded');

1
2
3
4

<button
    data-action="live#emit"
    data-live-event-param="name(ProductList)|productAdded"
>

1

$this->emit('productAdded', componentName: 'ProductList');

1
2
3
4

<button
    data-action="live#emitSelf"
    data-live-event-param="productAdded"
>

1

$this->emitSelf('productAdded');

Each component re-renders independent of one another

If a parent component re-renders, this won't, by default, cause any child components to re-render, but you can make it do that. Let's look at an example of a todo list component with a child that renders the total number of todo items:

1
2
3
4
5
6
7
8
9
10
11
12

{# templates/components/TodoList.html.twig #}
<div {{ attributes }}>
    <input data-model="listName">

    {% for todo in todos %}
        ...
    {% endfor %}

    {{ component('TodoFooter', {
        count: todos|length
    }) }}
</div>

Suppose the user updates the listName model and the parent component re-renders. In this case, the child component will not re-render by design: each component lives in its own universe.

However, if the user adds a new todo item then we do want the TodoFooter child component to re-render: using the new count value. To trigger this, in the TodoFooter component, add the updateFromParent option:

1
2
3
4
5
6

#[LiveComponent]
class TodoFooter
{
    #[LiveProp(updateFromParent: true)]
    public int $count = 0;
}

Now, when the parent component re-renders, if the value of the count prop changes, the child will make a second Ajax request to re-render itself.

Child components keep their modifiable LiveProp values

What if the TodoFooter component in the previous example also has an isVisible LiveProp(writable: true) property which starts as true but can be changed (via a link click) to false. Will re-rendering the child when count changes cause this to be reset back to its original value? Nope! When the child component re-renders, it will keep the current value for all props, except for those that are marked as updateFromParent.

What if you do want your entire child component to re-render (including resetting writable live props) when some value in the parent changes? This can be done by manually giving your component an id attribute that will change if the component should be totally re-rendered:

1
2
3
4
5
6
7
8
9

{# templates/components/TodoList.html.twig #}
<div {{ attributes }}>
    <!-- ... -->

    {{ component('TodoFooter', {
        count: todos|length,
        id: 'todo-footer-'~todos|length
    }) }}
</div>

In this case, if the number of todos change, then the id attribute of the component will also change. This signals that the component should re-render itself completely, discarding any writable LiveProp values.

Actions in a child do not affect the parent

Again, each component is its own, isolated universe! For example, suppose your child component has:

1

<button data-action="live#action" data-live-action-param="save">Save</button>

When the user clicks that button, it will attempt to call the save action in the child component only, even if the save action actually only exists in the parent. The same is true for data-model, though there is some special handling for this case (see next point).

Communicating with a Parent Component

There are two main ways to communicate from a child component to a parent component:

1. Emitting events

   The most flexible way to communicate: any information can be sent from the child to the parent.

2. Updating a parent model from a child

   Useful as a simple way to "synchronize" a child model with a parent model: when the child model changes, the parent model will also change.

Updating a Parent Model from a Child

Suppose a child component has a:

1

<textarea data-model="value">

When the user changes this field, this will only update the value field in the child component… because (yup, we're saying it again): each component is its own, isolated universe.

However, sometimes this isn't what you want! Sometimes, when a child model changes, that should also update a model on the parent. To do this, pass a dataModel (or data-model) attribute to the child:

1
2
3
4
5

{# templates/components/PostForm.html.twig #}
{{ component('TextareaField', {
    dataModel: 'content',
    error: _errors.get('content'),
}) }}

This does two things:

1. A prop called value will be passed into TextareaField set to content from the parent component (i.e. the same as manually passing value: content into the component).
2. When the value prop changes inside of TextareaField, the content prop will change on the parent component.

This result is that, when value changes, the parent component will also re-render, thanks to the fact that its content prop changed.

You can also specify the name of the child prop with the parentProp:childProp syntax. The following is the same as above:

1
2
3
4

<!-- same as dataModel: 'content' -->
{{ component('TextareaField', {
    dataModel: 'content:value',
}) }}

If your child component has multiple models, separate each with a space:

1
2
3

{{ component('TextareaField', {
    dataModel: 'user.firstName:first user.lastName:last',
}) }}

In this case, the child component will receive first and last props. And, when those update, the user.firstName and user.lastName models will be updated on the parent.

Full Embedded Component Example

Let's look at a full, complex example of an embedded component. Suppose you have an EditPost:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

namespace App\Twig\Components;

use App\Entity\Post;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
use Symfony\UX\LiveComponent\Attribute\LiveAction;
use Symfony\UX\LiveComponent\Attribute\LiveProp;

#[AsLiveComponent]
final class EditPost extends AbstractController
{
    #[LiveProp(writable: ['title', 'content'])]
    public Post $post;

    #[LiveAction]
    public function save(EntityManagerInterface $entityManager)
    {
        $entityManager->flush();

        return $this->redirectToRoute('some_route');
    }
}

And a MarkdownTextarea:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

namespace App\Twig\Components;

use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
use Symfony\UX\LiveComponent\Attribute\LiveProp;

#[AsLiveComponent]
final class MarkdownTextarea
{
    #[LiveProp]
    public string $label;

    #[LiveProp]
    public string $name;

    #[LiveProp(writable: true)]
    public string $value = '';
}

In the EditPost template, you render the MarkdownTextarea:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

{# templates/components/EditPost.html.twig #}
<div {{ attributes }}>
    <form data-model="on(change)|*">
        <input
            type="text"
            name="post[title]"
            value="{{ post.title }}"
        >

        {{ component('MarkdownTextarea', {
            name: 'post[content]',
            dataModel: 'post.content:value',
            label: 'Content',
        }) }}

        <button
            data-action="live#action"
            data-live-action-param="save"
        >Save</button>
    </form>
</div>

1
2
3
4
5
6
7
8
9
10

<div {{ attributes }} class="mb-3">
    <textarea
        name="{{ name }}"
        data-model="value"
    ></textarea>

    <div class="markdown-preview">
        {{ value|markdown_to_html }}
    </div>
</div>

Notice that MarkdownTextarea allows a dynamic name attribute to be passed in. This makes that component re-usable in any form.

Rendering Quirks with List of Elements

If you're rendering a list of elements in your component, to help LiveComponents understand which element is which between re-renders (i.e. if something re-orders or removes some of those elements), you can add a key attribute to each element

1
2
3
4
5
6

{# templates/components/Invoice.html.twig #}
{% for lineItem in lineItems %}
    <div key="{{ lineItem.id }}">
        {{ lineItem.name }}
    </div>
{% endfor %}

Rendering Quirks with List of Embedded Components

Imagine your component renders a list of child components and the list changes as the user types into a search box... or by clicking "delete" on an item. In this case, the wrong children may be removed or existing child components may not disappear when they should.

To fix this, add a key prop to each child component that's unique to that component:

1
2
3
4
5
6
7

{# templates/components/InvoiceCreator.html.twig #}
{% for lineItem in invoice.lineItems %}
    {{ component('InvoiceLineItemForm', {
        lineItem: lineItem,
        key: lineItem.id,
    }) }}
{% endfor %}

The key will be used to generate an id attribute, which will be used to identify each child component.

Tricks with a Loop + a "New" Item

Let's get fancier. After looping over the current line items, you decide to render one more component to create a new line item. In that case, you can pass in a key set to something like new_line_item:

1
2
3
4
5
6

{# templates/components/InvoiceCreator.html.twig #}
// ... loop and render the existing line item components

{{ component('InvoiceLineItemForm', {
    key: 'new_line_item',
}) }}

Imagine you also have a LiveAction inside of InvoiceLineItemForm that saves the new line item to the database. To be extra fancy, it emits a lineItem:created event to the parent:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

// src/Twig/InvoiceLineItemForm.php
// ...

#[AsLiveComponent]
final class InvoiceLineItemForm
{
    // ...

    #[LiveProp]
    #[Valid]
    public ?InvoiceLineItem $lineItem = null;

    #[PostMount]
    public function postMount(): void
    {
        if (!$this->lineItem) {
            $this->lineItem = new InvoiceLineItem();
        }
    }

    #[LiveAction]
    public function save(EntityManagerInterface $entityManager)
    {
        if (!$this->lineItem->getId()) {
            $this->emit('lineItem:created', $this->lineItem);
        }

        $entityManager->persist($this->lineItem);
        $entityManager->flush();
    }
}

Finally, the parent InvoiceCreator component listens to this so that it can re-render the line items (which will now contain the newly-saved item):

1
2
3
4
5
6
7
8
9
10
11
12
13
14

// src/Twig/InvoiceCreator.php
// ...

#[AsLiveComponent]
final class InvoiceCreator
{
    // ...

    #[LiveListener('lineItem:created')]
    public function addLineItem()
    {
        // no need to do anything here: the component will re-render
    }
}

This will work beautifully: when a new line item is saved, the InvoiceCreator component will re-render and the newly saved line item will be displayed along with the extra new_line_item component at the bottom.

But something surprising might happen: the new_line_item component won't update! It will keep the data and props that were there a moment ago (i.e. the form fields will still have data in them) instead of rendering a fresh, empty component.

Why? When live components re-renders, it thinks the existing key: new_line_item component on the page is the same new component that it's about to render. And because the props passed into that component haven't changed, it doesn't see any reason to re-render it.

To fix this, you have two options:

1) Make the key dynamic so it will be different after adding a new item:

1
2
3

{{ component('InvoiceLineItemForm', {
    key: 'new_line_item_'~lineItems|length,
}) }}

2) Reset the state of the InvoiceLineItemForm component after it's saved:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

// src/Twig/InvoiceLineItemForm.php
// ...

#[AsLiveComponent]
class InvoiceLineItemForm
{
    // ...

    #[LiveAction]
    public function save(EntityManagerInterface $entityManager)
    {
        $isNew = null === $this->lineItem->getId();

        $entityManager->persist($this->lineItem);
        $entityManager->flush();

        if ($isNew) {
            // reset the state of this component
            $this->emit('lineItem:created', $this->lineItem);
            $this->lineItem = new InvoiceLineItem();
            // if you're using ValidatableComponentTrait
            $this->clearValidation();
        }
    }
}

Passing Content (Blocks) to Components

Passing content via blocks to Live components works completely the same way you would pass content to Twig Components. Except with one important difference: when a component is re-rendered, any variables defined only in the "outside" template will not be available. For example, this won't work:

1
2
3
4
5
6

{# templates/some_page.html.twig #}
{% set message = 'Variables from the outer part of the template are only available during  the initial render' %}

{% component Alert %}
    {% block content %}{{ message }}{% endblock %}
{% endcomponent %}

Local variables do remain available:

1
2
3
4
5
6
7

{# templates/some_page.html.twig #}
{% component Alert %}
    {% block content %}
        {% set message = 'this works during re-rendering!' %}
        {{ message }}
    {% endblock %}
{% endcomponent %}

PostHydrate Hook

The #[PostHydrate] hook is called immediately after the component's state is loaded from the client. This is useful if you need to process or adjust the data once it's been hydrated.

PreDehydrate Hook

The #[PreDehydrate] hook is triggered just before your component's state is sent back to the client. You can use this to modify or clean up the data before it's serialized and returned to the client.

PreReRender Hook

The #[PreReRender] hook is called before your component is re-rendered during an HTTP request. It does not run during the initial render but is helpful when you need to adjust the state before sending it back to the client for re-rendering.

Hook Priority

You can control the order in which hooks are executed by using the priority argument. If multiple hooks of the same type are registered in a component, those with a higher priority value will run first. This allows you to manage the order in which your actions are performed within the same lifecycle stage:

1
2
3
4
5
6
7
8
9
10
11

#[PostHydrate(priority: 10)]
public function highPriorityHook(): void
{
    // Runs first
}

#[PostHydrate(priority: 1)]
public function lowPriorityHook(): void
{
    // Runs last
}

The Smart Re-Render Algorithm

When a component re-renders, the new HTML is "morphed" onto the existing elements on the page. For example, if the re-render includes a new class on an existing element, that class will be added to that element.

The rendering system is also smart enough to know when an element was changed by something outside of the LiveComponents system: e.g. some JavaScript that added a class to an element. In this case, the class will be preserved when the component re-renders.

The system doesn't handle every edge case, so here are some things to keep in mind:

• If JavaScript changes an attribute on a child element, that change is preserved.
• If JavaScript adds a new element, that element is preserved.
• If JavaScript removes an element that was originally rendered by the component, that change will be lost: the element will be re-added during the next re-render.
• If JavaScript changes the text of an element, that change is lost: it will be restored to the text from the server during the next re-render.
• If an element is moved from one location in the component to another, that change is lost: the element will be re-added in its original location during the next re-render.

The Mystical id Attribute

The id attribute is mentioned several times throughout the documentation to solve various problems. It's usually not needed, but can be the key to solving certain complex problems. But what is it?

The id attribute is a unique identifier for an element or a component. It's used during the morphing process when a component re-renders: it helps the morphing library "connect" elements or components in the existing HTML with the new HTML.

Skipping Updating Certain Elements

If you have an element inside a component that you do not want to change when your component re-renders, you can add a data-live-ignore attribute:

1

<input name="favorite_color" data-live-ignore>

But you should need this rarely if ever. Even if you write JavaScript that modifies an element, that changes is preserved (see Live Components).

Overwrite HTML Instead of Morphing

Normally, when a component re-renders, the new HTML is "morphed" onto the existing elements on the page. In some rare cases, you may want to simply overwrite the existing inner HTML of an element with the new HTML instead of morphing it. This can be done by adding a data-skip-morph attribute:

1
2
3

<select data-skip-morph>
    <option>...</option>
</select>

In this case, any changes to the <select> element attributes will still be "morphed" onto the existing element, but the inner HTML will be overwritten.

Define another route for your Component

The default route for live components is /components/{_live_component}/{_live_action}. Sometimes it may be useful to customize this URL - e.g. so that the component lives under a specific firewall.

To use a different route, first declare it:

1
2
3
4
5

# config/routes.yaml
live_component_admin:
    path: /admin/_components/{_live_component}/{_live_action}
    defaults:
        _live_action: 'get'

Then specify this new route on your component:

1
2
3
4
5
6
7
8
9
10

// src/Twig/Components/RandomNumber.php
use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
use Symfony\UX\LiveComponent\DefaultActionTrait;

- #[AsLiveComponent]
+ #[AsLiveComponent(route: 'live_component_admin')]
  class RandomNumber
  {
      use DefaultActionTrait;
  }

You can also control the type of the generated URL:

1
2
3
4
5
6
7
8
9
10
11

// src/Twig/Components/RandomNumber.php
+ use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
  use Symfony\UX\LiveComponent\DefaultActionTrait;

- #[AsLiveComponent]
+ #[AsLiveComponent(urlReferenceType: UrlGeneratorInterface::ABSOLUTE_URL)]
  class RandomNumber
  {
      use DefaultActionTrait;
  }

Add a Hook on LiveProp Update

If you want to run custom code after a specific LiveProp is updated, you can do it by adding an onUpdated option set to a public method name on the component:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

#[AsLiveComponent]
class ProductSearch
{
    #[LiveProp(writable: true, onUpdated: 'onQueryUpdated')]
    public string $query = '';

    // ...

    public function onQueryUpdated($previousValue): void
    {
        // $this->query already contains a new value
        // and its previous value is passed as an argument
    }
}

As soon as the query LiveProp is updated, the onQueryUpdated() method will be called. The previous value is passed there as the first argument.

If you're allowing object properties to be writable, you can also listen to the change of one specific key:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

use App\Entity\Post;

#[AsLiveComponent]
class EditPost
{
    #[LiveProp(writable: ['title', 'content'], onUpdated: ['title' => 'onTitleUpdated'])]
    public Post $post;

    // ...

    public function onTitleUpdated($previousValue): void
    {
        // ...
    }
}

Set LiveProp Options Dynamically

If you need to configure a LiveProp's options dynamically, you can use the modifier option to use a custom method in your component that returns a modified version of your LiveProp:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

#[AsLiveComponent]
class ProductSearch
{
    #[LiveProp(writable: true, modifier: 'modifyAddedDate')]
    public ?\DateTimeImmutable $addedDate = null;

    #[LiveProp]
    public string $dateFormat = 'Y-m-d';

    // ...

    public function modifyAddedDate(LiveProp $prop): LiveProp
    {
        return $prop->withFormat($this->dateFormat);
    }
}

Then, when using your component in a template, you can change the date format used for $addedDate:

1
2
3

{{ component('ProductSearch', {
    dateFormat: 'd/m/Y'
}) }}

All LiveProp::with* methods are immutable, so you need to use their return value as your new LiveProp.

Interact With Live-Components

For testing, you can use the InteractsWithLiveComponents trait which uses Symfony's test client to render and make requests to your components:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\UX\LiveComponent\Test\InteractsWithLiveComponents;

class MyComponentTest extends KernelTestCase
{
    use InteractsWithLiveComponents;

    public function testCanRenderAndInteract(): void
    {
        $testComponent = $this->createLiveComponent(
            name: 'MyComponent', // can also use FQCN (MyComponent::class)
            data: ['foo' => 'bar'],
        );

        // render the component html
        $this->assertStringContainsString('Count: 0', $testComponent->render());

        // call live actions
        $testComponent
            ->call('increase')
            ->call('increase', ['amount' => 2]) // call a live action with arguments
        ;

        $this->assertStringContainsString('Count: 3', $testComponent->render());

        // call live action with file uploads
        $testComponent
            ->call('processUpload', files: ['file' => new UploadedFile(...)]);

        // emit live events
        $testComponent
            ->emit('increaseEvent')
            ->emit('increaseEvent', ['amount' => 2]) // emit a live event with arguments
        ;

        // set live props
        $testComponent
            ->set('count', 99)
        ;

        // Submit form data ('my_form' for your MyFormType form)
        $testComponent
            ->submitForm(['my_form' => ['input' => 'value']], 'save');

        $this->assertStringContainsString('Count: 99', $testComponent->render());

        // refresh the component
        $testComponent->refresh();

        // access the component object (in its current state)
        $component = $testComponent->component(); // MyComponent

        $this->assertSame(99, $component->count);

        // test a live action that redirects
        $response = $testComponent->call('redirect')->response(); // Symfony\Component\HttpFoundation\Response

        $this->assertSame(302, $response->getStatusCode());

        // authenticate a user ($user is instance of UserInterface)
        $testComponent->actingAs($user);

        // set the '_locale' route parameter (if the component route is localized)
        $testComponent->setRouteLocale('fr');

        // customize the test client
        $client = self::getContainer()->get('test.client');

        // do some stuff with the client (ie login user via form)

        $testComponent = $this->createLiveComponent(
            name: 'MyComponent',
            data: ['foo' => 'bar'],
            client: $client,
        );
    }
}

Test LiveCollectionType

To test the submission of a form within a Live Component (with the above submitForm helper) containing a LiveCollectionType, you first need to programmatically add the desired number of entries to the form, replicating the action of clicking the "Add" button.

So, if the following are the forms used:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

use Symfony\UX\LiveComponent\Form\Type\LiveCollectionType;

// Parent FormType used in the Live Component
class LiveCollectionFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('children', LiveCollectionType::class, [
                'entry_type' => ChildFormType::class,
            ])
        ;
    }
}

// Child Form Type used for each entry in the collection
class ChildFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('name', TextType::class)
            ->add('age', IntegerType::class)
        ;
    }
}

Use the addCollectionItem method from the LiveCollectionTrait to dynamically add entries to the children field of the form before submitting it:

1
2
3
4
5
6
7
8
9
10
11
12

// Call the addCollectionItem method as many times as needed, specifying the name of the collection field.
$component->call('addCollectionItem', ['name' => 'children']);
$component->call('addCollectionItem', ['name' => 'children']);
//... can be called as many times as you need entries in your 'children' field

// ... then submit the form by providing data for all the fields in the ChildFormType for each added entry:
$component->submitForm([ 'live_collection_form' => [
    'children' => [
        ['name' => 'childName1', 'age' => 10],
        ['name' => 'childName2', 'age' => 15],
    ]
]]);