Neutrino Image Loader Middleware

NPM version NPM downloads Join Slack

neutrino-middleware-image-loader is Neutrino middleware for loading and importing image files from modules.

Requirements

  • Node.js v6.10+
  • Yarn or npm client
  • Neutrino v6

Installation

neutrino-middleware-image-loader can be installed via the Yarn or npm clients.

Yarn

❯ yarn add neutrino-middleware-image-loader

npm

npm install --save neutrino-middleware-image-loader

Usage

neutrino-middleware-image-loader can be consumed from the Neutrino API, middleware, or presets. Require this package and plug it into Neutrino:

// Using function middleware format
const images = require('neutrino-middleware-image-loader');

// Use with default options
neutrino.use(images);

// Usage showing default options
neutrino.use(images, {
  limit: 8192,
  svg: {},
  img: {},
  ico: {}
});
// Using object or array middleware format

// Use with default options
module.exports = {
  use: ['neutrino-middleware-image-loader']
};

// Usage showing default options
module.exports = {
  use: [
    ['neutrino-middleware-image-loader', {
      limit: 8192,
      svg: {},
      img: {},
      ico: {}
    }]
  ]
};
  • limit: Return a Data URL if the file is smaller than a byte limit.
  • svg: Set options for the svg-url-loader used when loading svg files.
  • img: Set options for the url-loader used when loading png, jpeg, and gif files.
  • ico: Set options for the url-loader used when loading ico files.

Customization

neutrino-middleware-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 Environments
img Allows importing JPEG, PNG, and GIF files from modules. Contains a single loader named url. all
svg Allows importing SVG files from modules. Contains a single loader named url. all
ico Allows importing ICO files from modules. Contains a single loader named url. all

Contributing

This middleware is part of the neutrino-dev repository, a monorepo containing all resources for developing Neutrino and its core presets and middleware. Follow the contributing guide for details.

results matching ""

    No results matching ""