Neutrino Font Loader Middleware

NPM version NPM downloads Join Slack

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

Requirements

  • Node.js v6.9+
  • Yarn or npm client
  • Neutrino v5

Installation

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

Yarn

❯ yarn add neutrino-middleware-font-loader

npm

npm install --save neutrino-middleware-font-loader

Usage

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

const fonts = require('neutrino-middleware-font-loader');

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

// Usage showing default options
neutrino.use(fonts, {
  limit: '10000',
  woff: {},
  ttf: {},
  eot: {}
});
  • limit: Return a Data URL if the file is smaller than a byte limit.
  • woff: Set options for the url-loader used when loading woff files.
  • tff: Set options for the url-loader used when loading ttf files.
  • eot: Set options for the file-loader used when loading eot files.

Customization

neutrino-middleware-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:

  • woff: Allows importing WOFF font files from modules. Contains a single loader named url.
  • ttf: Allows importing TTF font files from modules. Contains a single loader named url.
  • eot: Allows importing EOT font files from modules. Contains a single loader named file.

Contributing

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

results matching ""

    No results matching ""