Skip to content

Inlining files in CSS with Webpack URL Loader

Warning: You are browsing the documentation for Symfony 4.x, which is no longer maintained.

Read the updated version of this page for Symfony 7.1 (the current stable version).

A simple technique to improve the performance of web applications is to reduce the number of HTTP requests inlining small files as base64 encoded URLs in the generated CSS files.

Webpack Encore provides this feature via Webpack's URL Loader plugin, but it's disabled by default. First, add the URL loader to your project:

1
2
3
4
5
# if you use the Yarn package manager
$ yarn add url-loader --dev

# if you use the npm package manager
$ npm install url-loader --save-dev

Then enable it in your webpack.config.js:

1
2
3
4
5
6
7
8
9
10
// webpack.config.js
// ...

Encore
    // ...
    .configureUrlLoader({
        fonts: { limit: 4096 },
        images: { limit: 4096 }
    })
;

The limit option defines the maximum size in bytes of the inlined files. In the previous example, font and image files having a size below or equal to 4 KB will be inlined and the rest of the files will be processed as usual.

You can also use all the other options supported by the URL Loader. If you want to disable this loader for either images or fonts, remove the corresponding key from the object that is passed to the configureUrlLoader() method:

1
2
3
4
5
6
7
8
9
10
// webpack.config.js
// ...

Encore
    // ...
    .configureUrlLoader({
        // 'fonts' is not defined, so only images will be inlined
        images: { limit: 4096 }
    })
;
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version