Skip to content

Commit eaa1276

Browse files
committed
minor #1779 [LiveComponent] Add a note about render:finished event (smnandre)
This PR was squashed before being merged into the 2.x branch. Discussion ---------- [LiveComponent] Add a note about render:finished event The `render:finished` event is not dispatched when the component is initially rendered in Twig As a couple of users have missed this information while reading the documentation, I suggest a little admonition to emphasis it :) Commits ------- 1463b7e [LiveComponent] Add a note about render:finished event
2 parents 96bf028 + 1463b7e commit eaa1276

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/LiveComponent/doc/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -905,6 +905,11 @@ component system from Stimulus:
905905
}
906906
}
907907
908+
.. note::
909+
910+
The ``render:started`` and ``render:finished`` events are only dispatched
911+
when the component is **re**-rendered (via an action or a model change).
912+
908913
The following hooks are available (along with the arguments that are passed):
909914

910915
* ``connect`` args ``(component: Component)``

0 commit comments

Comments
 (0)