JSPM

  • Created
  • Published
  • Downloads 815
  • Score
    100M100P100Q9054F
  • License MPL-2.0

Neutrino middleware for importing and loading font files from modules

Package Exports

  • @neutrinojs/font-loader

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@neutrinojs/font-loader) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Neutrino Font Loader Middleware

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

NPM version NPM downloads Join the Neutrino community on Spectrum

Requirements

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

Installation

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

Yarn

yarn add @neutrinojs/font-loader

npm

npm install --save @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:

// Using function middleware format
const fonts = require('@neutrinojs/font-loader');

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

// Usage showing default options
neutrino.use(fonts, {
  limit: '10000',
  woff: {},
  ttf: {},
  eot: {}
});
// Using object or array middleware format

// Use with default options
module.exports = {
  use: ['@neutrinojs/font-loader']
};

// Usage showing default options
module.exports = {
  use: [
    ['@neutrinojs/font-loader', {
      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

@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 Environments and Commands
woff Allows importing WOFF font files from modules. Contains a single loader named url. all
ttf Allows importing TTF font files from modules. Contains a single loader named url. all
eot Allows importing EOT font files from modules. Contains a single loader named file. 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.