Skip to content

[LiveComponent] Document getComponent install with AssetMapper #1406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

[LiveComponent] Document getComponent install with AssetMapper #1406

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb347cd
[LiveComponent] Document ``getComponent`` install with AssetMapper
smnandre Jan 18, 2024
6af9520
CS
smnandre Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/LiveComponent/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -821,6 +821,13 @@ controller and put it around (or attached to) your root component element:
}
}

With AssetMapper, you need to add ``@symfony/ux-live-component`` in the
``importmap.php`` configuration file:

.. code-block:: terminal

$ php bin/console importmap:require @symfony/ux-live-component --path=@symfony/ux-live-component/live_controller.js

You can also access the ``Component`` object via a special property
on the root component element, though ``getComponent()`` is the
recommended way, as it will work even if the component is not yet
Expand Down