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.

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

[AssetMapper] Update hash examples #20490

Open
wants to merge 1 commit into
base: 7.2
Choose a base branch
from
+12 −12
Open

[AssetMapper] Update hash examples #20490

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions frontend/asset_mapper.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The component has two main features:
* :ref:`Mapping & Versioning Assets <mapping-assets>`: All files inside of ``assets/``
are made available publicly and **versioned**. You can reference the file
``assets/images/product.jpg`` in a Twig template with ``{{ asset('images/product.jpg') }}``.
The final URL will include a version hash, like ``/assets/images/product-3c16d9220694c0e56d8648f25e6035e9.jpg``.
The final URL will include a version hash, like ``/assets/images/product-3c16d92m.jpg``.

* :ref:`Importmaps <importmaps-javascript>`: A native browser feature that makes it easier
to use the JavaScript ``import`` statement (e.g. ``import { Modal } from 'bootstrap'``)
Expand Down Expand Up @@ -70,15 +70,15 @@ The path - ``images/duck.png`` - is relative to your mapped directory (``assets/
This is known as the **logical path** to your asset.

If you look at the HTML in your page, the URL will be something
like: ``/assets/images/duck-3c16d9220694c0e56d8648f25e6035e9.png``. If you change
like: ``/assets/images/duck-3c16d92m.png``. If you change
the file, the version part of the URL will also change automatically.

.. _asset-mapper-compile-assets:

Serving Assets in dev vs prod
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In the ``dev`` environment, the URL ``/assets/images/duck-3c16d9220694c0e56d8648f25e6035e9.png``
In the ``dev`` environment, the URL ``/assets/images/duck-3c16d92m.png``
is handled and returned by your Symfony app.

For the ``prod`` environment, before deploy, you should run:
Expand Down Expand Up @@ -283,9 +283,9 @@ outputs an `importmap`_:

<script type="importmap">{
"imports": {
"app": "/assets/app-4e986c1a2318dd050b1d47db8d856278.js",
"/assets/duck.js": "/assets/duck-1b7a64b3b3d31219c262cf72521a5267.js",
"bootstrap": "/assets/vendor/bootstrap/bootstrap.index-f0935445d9c6022100863214b519a1f2.js"
"app": "/assets/app-4e986c1a.js",
"/assets/duck.js": "/assets/duck-1b7a64b3.js",
"bootstrap": "/assets/vendor/bootstrap/bootstrap.index-f093544d.js"
}
}</script>

Expand Down Expand Up @@ -342,8 +342,8 @@ The ``importmap()`` function also outputs a set of "preloads":

.. code-block:: html

<link rel="modulepreload" href="/assets/app-4e986c1a2318dd050b1d47db8d856278.js">
<link rel="modulepreload" href="/assets/duck-1b7a64b3b3d31219c262cf72521a5267.js">
<link rel="modulepreload" href="/assets/app-4e986c1a.js">
<link rel="modulepreload" href="/assets/duck-1b7a64b3.js">

This is a performance optimization and you can learn more about below
in :ref:`Performance: Add Preloading <performance-preloading>`.
Expand Down Expand Up @@ -494,9 +494,9 @@ for ``duck.png``:

.. code-block:: css

/* public/assets/styles/app-3c16d9220694c0e56d8648f25e6035e9.css */
/* public/assets/styles/app-3c16d92m.css */
.quack {
background-image: url('../images/duck-3c16d9220694c0e56d8648f25e6035e9.png');
background-image: url('../images/duck-3c16d92m.png');
}

.. _asset-mapper-tailwind:
Expand Down Expand Up @@ -573,7 +573,7 @@ Sometimes a JavaScript file you're importing (e.g. ``import './duck.js'``),
or a CSS/image file you're referencing won't be found, and you'll see a 404
error in your browser's console. You'll also notice that the 404 URL is missing
the version hash in the filename (e.g. a 404 to ``/assets/duck.js`` instead of
a path like ``/assets/duck.1b7a64b3b3d31219c262cf72521a5267.js``).
a path like ``/assets/duck-1b7a64b3.js``).

This is usually because the path is wrong. If you're referencing the file
directly in a Twig template:
Expand Down Expand Up @@ -848,7 +848,7 @@ be versioned! It will output something like:

.. code-block:: html+twig

<link rel="stylesheet" href="/assets/bundles/babdevpagerfanta/css/pagerfanta-ea64fc9c55f8394e696554f8aeb81a8e.css">
<link rel="stylesheet" href="/assets/bundles/babdevpagerfanta/css/pagerfanta-ea64fc9c.css">

Overriding 3rd-Party Assets
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading