Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

url-loader

Package Overview
Dependencies
3
Maintainers
6
Versions
32
Issues
File Explorer

Advanced tools

url-loader

A loader for webpack which transforms files into base64 URIs

    4.1.1latest

Version published
Maintainers
6
Weekly downloads
8,524,377
decreased by-9.48%

Weekly downloads

Changelog

Source

4.1.1 (2020-10-09)

Chore

  • update schema-utils

Readme

Source

npm node deps tests chat size

url-loader

A loader for webpack which transforms files into base64 URIs.

Getting Started

To begin, you'll need to install url-loader:

$ npm install url-loader --save-dev

url-loader works like file-loader, but can return a DataURL if the file is smaller than a byte limit.

index.js

import img from './image.png';

webpack.config.js

module.exports = { module: { rules: [ { test: /\.(png|jpg|gif)$/i, use: [ { loader: 'url-loader', options: { limit: 8192, }, }, ], }, ], }, };

And run webpack via your preferred method.

Options

NameTypeDefaultDescription
limit{Boolean|Number|String}trueSpecifying the maximum size of a file in bytes.
mimetype{Boolean|String}based from mime-typesSets the MIME type for the file to be transformed.
encoding{Boolean|String}base64Specify the encoding which the file will be inlined with.
generator{Function}() => type/subtype;encoding,base64_dataYou can create you own custom implementation for encoding data.
fallback{String}file-loaderSpecifies an alternative loader to use when a target file's size exceeds the limit.
esModule{Boolean}trueUse ES modules syntax.

limit

Type: Boolean|Number|String Default: undefined

The limit can be specified via loader options and defaults to no limit.

Boolean

Enable or disable transform files into base64.

webpack.config.js

module.exports = { module: { rules: [ { test: /\.(png|jpg|gif)$/i, use: [ { loader: 'url-loader', options: { limit: false, }, }, ], }, ], }, };
Number|String

A Number or String specifying the maximum size of a file in bytes. If the file size is equal or greater than the limit file-loader will be used (by default) and all query parameters are passed to it.

Using an alternative to file-loader is enabled via the fallback option.

webpack.config.js

module.exports = { module: { rules: [ { test: /\.(png|jpg|gif)$/i, use: [ { loader: 'url-loader', options: { limit: 8192, }, }, ], }, ], }, };

mimetype

Type: Boolean|String Default: based from mime-types

Specify the mimetype which the file will be inlined with. If unspecified the mimetype value will be used from mime-types.

Boolean

The true value allows to generation the mimetype part from mime-types. The false value removes the mediatype part from a Data URL (if omitted, defaults to text/plain;charset=US-ASCII).

webpack.config.js

module.exports = { module: { rules: [ { test: /\.(png|jpg|gif)$/i, use: [ { loader: 'url-loader', options: { mimetype: false, }, }, ], }, ], }, };
String

Sets the MIME type for the file to be transformed.

webpack.config.js

module.exports = { module: { rules: [ { test: /\.(png|jpg|gif)$/i, use: [ { loader: 'url-loader', options: { mimetype: 'image/png', }, }, ], }, ], }, };

encoding

Type: Boolean|String Default: base64

Specify the encoding which the file will be inlined with. If unspecified the encoding will be base64.

Boolean

If you don't want to use any encoding you can set encoding to false however if you set it to true it will use the default encoding base64.

webpack.config.js

module.exports = { module: { rules: [ { test: /\.svg$/i, use: [ { loader: 'url-loader', options: { encoding: false, }, }, ], }, ], }, };
String

It supports Node.js Buffers and Character Encodings which are ["utf8","utf16le","latin1","base64","hex","ascii","binary","ucs2"].

webpack.config.js

module.exports = { module: { rules: [ { test: /\.svg$/i, use: [ { loader: 'url-loader', options: { encoding: 'utf8', }, }, ], }, ], }, };

generator

Type: Function Default: (mimetype, encoding, content, resourcePath) => mimetype;encoding,base64_content

You can create you own custom implementation for encoding data.

webpack.config.js

module.exports = { module: { rules: [ { test: /\.(png|html)$/i, use: [ { loader: 'url-loader', options: { // The `mimetype` and `encoding` arguments will be obtained from your options // The `resourcePath` argument is path to file. generator: (content, mimetype, encoding, resourcePath) => { if (/\.html$/i.test(resourcePath)) { return `data:${mimetype},${content.toString()}`; } return `data:${mimetype}${ encoding ? `;${encoding}` : '' },${content.toString(encoding)}`; }, }, }, ], }, ], }, };

fallback

Type: String Default: 'file-loader'

Specifies an alternative loader to use when a target file's size exceeds the limit set in the limit option.

webpack.config.js

module.exports = { module: { rules: [ { test: /\.(png|jpg|gif)$/i, use: [ { loader: 'url-loader', options: { fallback: require.resolve('responsive-loader'), }, }, ], }, ], }, };

The fallback loader will receive the same configuration options as url-loader.

For example, to set the quality option of a responsive-loader above use:

webpack.config.js

module.exports = { module: { rules: [ { test: /\.(png|jpg|gif)$/i, use: [ { loader: 'url-loader', options: { fallback: require.resolve('responsive-loader'), quality: 85, }, }, ], }, ], }, };

esModule

Type: Boolean Default: true

By default, file-loader generates JS modules that use the ES modules syntax. There are some cases in which using ES modules is beneficial, like in the case of module concatenation and tree shaking.

You can enable a CommonJS module syntax using:

webpack.config.js

module.exports = { module: { rules: [ { test: /\.css$/, use: [ { loader: 'url-loader', options: { esModule: false, }, }, ], }, ], }, };

Examples

SVG

SVG can be compressed into a more compact output, avoiding base64. You can read about it more here. You can do it using mini-svg-data-uri package.

webpack.config.js

const svgToMiniDataURI = require('mini-svg-data-uri'); module.exports = { module: { rules: [ { test: /\.svg$/i, use: [ { loader: 'url-loader', options: { generator: (content) => svgToMiniDataURI(content.toString()), }, }, ], }, ], }, };

Contributing

Please take a moment to read our contributing guidelines if you haven't yet done so.

CONTRIBUTING

License

MIT

Keywords

FAQs

What is url-loader?

A loader for webpack which transforms files into base64 URIs

Is url-loader popular?

The npm package url-loader receives a total of 6,853,719 weekly downloads. As such, url-loader popularity was classified as popular.

Is url-loader well maintained?

We found that url-loader demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 6 open source maintainers collaborating on the project.

Last updated on 09 Oct 2020

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc