Neutrino Image Loader Middleware
@neutrinojs/image-loader
is Neutrino middleware for loading and importing
image files from modules.
Requirements
- Node.js 10+
- Yarn v1.2.1+, or npm v5.4+
- Neutrino 9
- webpack 4
Installation
@neutrinojs/image-loader
can be installed via the Yarn or npm clients.
Yarn
❯ yarn add --dev @neutrinojs/image-loader
npm
❯ npm install --save-dev @neutrinojs/image-loader
Usage
@neutrinojs/image-loader
can be consumed from the Neutrino API, middleware, or
presets. Require this package and plug it into Neutrino:
const images = require('@neutrinojs/image-loader');
// Use with default options
neutrino.use(images());
// Usage showing default options
neutrino.use(
images({
limit: 8192,
name:
process.env.NODE_ENV === 'production'
? 'assets/[name].[hash:8].[ext]'
: 'assets/[name].[ext]',
}),
);
// Using in .neutrinorc.js
const images = require('@neutrinojs/image-loader');
// Use with default options
module.exports = {
use: [images()],
};
// Usage showing default options
module.exports = {
use: [
images({
limit: 8192,
name:
process.env.NODE_ENV === 'production'
? 'assets/[name].[hash:8].[ext]'
: 'assets/[name].[ext]',
}),
],
};
-
limit
: Return a Data URL instead of outputting a file, if the file is smaller than a byte limit. -
name
: The template used byfile-loader
to determine the output filename.
Customization
@neutrinojs/image-loader
creates some conventions to make overriding the
configuration easier once you are ready to make changes.
Rules
The following is a list of rules and their identifiers which can be overridden:
Name | Description | NODE_ENV |
---|---|---|
image |
Allows importing ICO, JPEG, PNG, GIF, SVG and WEBP files from modules. Contains a single loader named url . |
all |
Contributing
This middleware is part of the neutrino repository, a monorepo containing all resources for developing Neutrino and its core presets and middleware. Follow the contributing guide for details.