You will notice in the project structure we have two directories for static assets:
src/statics/. What is the difference between them?
To answer this question, we first need to understand how Webpack deals with static assets. In
*.vue components, all your templates and CSS are parsed by
css-loader to look for asset URLs. For example, in
<img src="./logo.png"> and
"./logo.png" is a relative asset path and will be resolved by Webpack as a module dependency.
file-loader to process it. The boilerplate has already configured these loaders for you, so you basically get features such as filename fingerprinting and conditional base64 inlining for free, while being able to use relative/module paths without worrying about deployment.
Since these assets may be inlined/copied/renamed during build, they are essentially part of your source code. This is why it is recommended to place Webpack-processed static assets inside
/src/assets, along side other source files. In fact, you don’t even have to put them all in
/src/assets: you can organize them based on the module/component using them. For example, you can put each component in its own directory, with its static assets right next to it.
Relative URLs, e.g.
./assets/logo.png will be interpreted as a module dependency. They will be replaced with a auto-generated URL based on your Webpack output configuration.
Non-prefixed URLs, e.g.
assets/logo.png will be treated the same as the relative URLs and translated into
URLs prefixed with
~ are treated as a module request, similar to
require('some-module/image.png'). You need to use this prefix if you want to leverage Webpack’s module resolving configurations. For example if you have a resolve alias for assets, you need to use
<img src="~assets/logo.png"> to ensure that alias is respected.
Root-relative URLs, e.g.
/assets/logo.png are not processed at all. This should be placed in
You can force serving static assets by using
srcas a Vue property. Instead of
:src="'statics/path/to/image'". Please note the usage of single and double quotes.
In order for Webpack to return the correct asset paths, you need to use
require('./relative/path/to/file.jpg'), which will get processed by
file-loader and returns the resolved URL. For example:
Note the above example will include every image under
./bgs/ in the final build. This is because Webpack cannot guess which of them will be used at runtime, so it includes them all.
In comparison, files in
src/statics/ are not processed by Webpack at all: they are directly copied to their final destination as-is, with the same filename. You must reference these files using absolute paths, which is determined by
As an example, with the following default values:
Any file placed in
src/statics/ should be referenced using the absolute URL