[Doc] Update the docs about the mount() method of Twig components #2843
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
javiereguiluz
added
docs
Kocal
reviewed
Jun 16, 2025
Comment on lines
+450
to
+452
| Most of the time, you will create public properties and pass values to them | ||
| as "props" when rendering the component. However, there are several hooks | ||
| available when you need to perform more complex logic. |
Kocal
reviewed
Jun 16, 2025
Comment on lines
+457
to
+458
| The ``mount()`` method gives you more control over how your "props" are handled. | ||
| It is called only once: immediately after your component is instantiated. |
Kocal
reviewed
Jun 16, 2025
Comment on lines
+459
to
+460
| The ``mount()`` method **cannot access the values of the public properties** | ||
| passed when rendering the component. |
There was a problem hiding this comment.
I see what you mean, but this is wrong if I want to be picky:
- you can access the public properties values, if they are not typed or have a default values
- speaking about only "public properties values" can be misleading, I feel like we should speak about the "props" too in priority
| { | ||
| {# ✅ this works as expected #} | ||
| if ($isError) { | ||
| // ... |
There was a problem hiding this comment.
Like it was done before, we should keep an example (or document) that we can modify a property here
Suggested change
| // ... | |
| $this->type = 'danger'; |
Comment on lines
+510
to
+514
| Now, pass the ``mount()`` argument like any other prop: | ||
|
|
||
| .. code-block:: html+twig | ||
|
|
||
| <twig:Alert | ||
| isSuccess="{{ false }}" | ||
| message="Danger Will Robinson!" | ||
| /> | ||
| <twig:Alert isError="{{ true }}" message="..."/> |
There was a problem hiding this comment.
Can we move it just under Instead, define the values you need in the ``mount()`` method as arguments::? I feel like the actual sections order can be misleading
| component is instantiated. Because the method has an ``$isSuccess`` | ||
| argument, if we pass an ``isSuccess`` prop when rendering, it will be | ||
| passed to ``mount()``. | ||
| Instead, define the values you need in the ``mount()`` method as arguments:: |
There was a problem hiding this comment.
The parameters you define in mount() does not only refer to your Component's public properties, but can be any props. For example, if I use <twig:Alert toto="tata">, then I can retrieve its value with public function mount(string $toto):
Suggested change
| Instead, define the values you need in the ``mount()`` method as arguments:: | |
| Instead, the props values are available in the ``mount()`` method as arguments:: |
Kocal
added
Status: Needs Work
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today I had some issues understanding how the
mount()method works, so I propose these changes to clarify things.