Initializing a component with a "Post"

[Nek-]

The documentation states that a LiveProp may be an entity however there's no example of how to instantiate the component with the entity. And... There are tricks here!

In my case I had a mount() function:

#[LiveProp]
public Post $post;

public function mount(Post $post)
{
    // .. doing something
}

It's actually required here to hydrate manually the prop:

#[LiveProp]
public Post $post;

public function mount(Post $post)
{
    $this->post = $post;
    // .. doing something
}

More like a doc issue than an actual problem.

[Kocal]

Nice catch, would you mind opening a PR? 🙏🏻

[Nek-]

@Kocal I took a look at the doc and how to improve it but I'm pretty sure it will be refused, it's a bit complicated because it also implies the mount function not being documented...

[smnandre]

I don't understand... why would it be refused ?

I did not find your example in the current documentation, but there is some here on the TwigComponent mount method:
https://symfony.com/bundles/ux-twig-component/current/index.html#mounting-data

We do not insist that much on the mount in the LiveComponent documentation.. To not repeat ourselves too much.. but also because the method is less central here.. it is only called once when the pre/hydrate hooks have a bigger role during the live component lifecycle.

Now.. we would warmly welcome any PR that improves both components documentation!

[Nek-]

I understand that documenting the mount method in the live component part would be somehow a re-edition of the doc, but point is that the behavior of the mount method is a bit tricky within livecomponents! Still a critical part of the component though. I may try to provide a doc part for the mount method in the context of live components to make things more clear.