Neutrino Font Loader Middleware

@neutrinojs/font-loader is Neutrino middleware for loading and importing font files from modules.

NPM version NPM downloads

Requirements

  • Node.js ^8.10 or 10+
  • Yarn v1.2.1+, or npm v5.4+
  • Neutrino 9
  • webpack 4

Installation

@neutrinojs/font-loader can be installed via the Yarn or npm clients.

Yarn

❯ yarn add --dev @neutrinojs/font-loader

npm

❯ npm install --save-dev @neutrinojs/font-loader

Usage

@neutrinojs/font-loader can be consumed from the Neutrino API, middleware, or presets. Require this package and plug it into Neutrino:

const fonts = require('@neutrinojs/font-loader');

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

// Usage showing default options
neutrino.use(
  fonts({
    name:
      process.env.NODE_ENV === 'production'
        ? 'assets/[name].[hash:8].[ext]'
        : 'assets/[name].[ext]',
  }),
);
// Using in .neutrinorc.js
const fonts = require('@neutrinojs/font-loader');

// Use with default options
module.exports = {
  use: [fonts()],
};

// Usage showing default options
module.exports = {
  use: [
    fonts({
      name:
        process.env.NODE_ENV === 'production'
          ? 'assets/[name].[hash:8].[ext]'
          : 'assets/[name].[ext]',
    }),
  ],
};
  • name: The template used by file-loader to determine the output filename.

Customization

@neutrinojs/font-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
font Allows importing EOT, TTF, WOFF and WOFF2 font files from modules. Contains a single loader named file. 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.