Copying & Referencing Images

3.4 version
Maintained Unmaintained
4.1

Copying & Referencing Images

Need to reference a static file - like the path to an image for an img tag? That can be tricky if you store your assets outside of the public document root. Fortunately, depending on your situation, there is a solution!

Referencing Images from Inside a Webpacked JavaScript File

To reference an image tag from inside a JavaScript file, require the file:

1
2
3
4
5
6
7
// assets/js/app.js

// returns the final, public path to this file
// path is relative to this file - e.g. assets/images/logo.png
const logoPath = require('../images/logo.png');

var html = `<img src="${logoPath}">`;

When you require (or import) an image file, Webpack copies it into your output directory and returns the final, public path to that file.

Referencing Image files from a Template

To reference an image file from outside of a JavaScript file that's processed by Webpack - like a template - you can use the copyFiles() method to copy those files into your final output directory.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
// webpack.config.js

Encore
    // ...
    .setOutputPath('web/build/')

+     .copyFiles({
+         from: './assets/images',
+
+         // optional target path, relative to the output dir
+         //to: 'images/[path][name].[ext]',
+
+         // if versioning is enabled, add the file hash too
+         //to: 'images/[path][name].[hash:8].[ext]',
+
+         // only copy files matching this pattern
+         //pattern: /\.(png|jpg|jpeg)$/
+     })

This will copy all files from assets/images into web/build (the output path). If you have versioning enabled, the copied files will include a hash based on their content.

To render inside Twig, use the asset() function:

1
2
3
4
5
{# assets/images/logo.png was copied to web/build/logo.png #}
<img src="{{ asset('build/logo.png') }}">

{# assets/images/subdir/logo.png was copied to web/build/subdir/logo.png #}
<img src="{{ asset('build/subdir/logo.png') }}">

Make sure you've enabled the json_manifest_path option, which tells the asset() function to read the final paths from the manifest.json file. If you're not sure what path argument to pass to the asset() function, find the file in manifest.json and use the key as the argument.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.