Skip to content
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.

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

[Docs][LiveComponent] Add very simple download files docs #2513

Open
wants to merge 7 commits into
base: 2.x
Choose a base branch
from
Open
Changes from 6 commits
Commits
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
37 changes: 37 additions & 0 deletions src/LiveComponent/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1326,6 +1326,43 @@ The files will be available in a regular ``$request->files`` files bag::
need to specify ``multiple`` attribute on HTML element and end ``name``
with ``[]``.

.. _downloads:

Downloading files
-----------------

Currently, Live Components do not natively support returning file responses directly from a LiveAction. However, you can implement file downloads by redirecting to a route that handles the file response.

Create a LiveAction that generates the URL for the file download and returns a `RedirectResponse`::

#[LiveAction]
public function initiateDownload(UrlGeneratorInterface $urlGenerator): RedirectResponse
{
$url = $urlGenerator->generate('app_file_download');
return new RedirectResponse($url);
}
zefyx marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: html+twig

<div {{ attributes }} data-turbo="false">
<button
data-action="live#action"
data-live-action-param="initiateDownload"
>
Download
</button>
</div>


.. tip::

When Turbo is enabled, if a LiveAction response redirects to another URL, Turbo will make a request to prefetch the content. Here, adding ``data-turbo="false"`` ensures that the download URL is called only once.

.. note::

Native support for file downloads in Live Components is under development. For more details, refer to the related `pull request #2483 <https://github.com/symfony/ux/pull/2483>`_.

zefyx marked this conversation as resolved.
Show resolved Hide resolved
zefyx marked this conversation as resolved.
Show resolved Hide resolved

.. _forms:

Forms
Expand Down
Loading