Giter Club home page Giter Club logo

postcss-fontpie's Introduction

postcss-fontpie

A PostCSS plugin for optimizing font loading layout shifts using fontpie!

Features

  • Automated: Generates fallback font metrics to match any custom web font!
  • Flexible: Handles font type (sans serif, serif, and monospace), weight, and style
  • Robust: Powered by the superb fontpie

Install

$ npm i postcss-fontpie

Usage

input.css

@font-face {
  font-family: 'Noto Serif';
  font-weight: 400;
  font-style: italic;
  font-display: swap;
  src: url(NotoSerif-Italic.ttf) format('ttf');
}

@font-face {
  font-family: 'Roboto';
  font-weight: 400;
  font-style: normal;
  font-display: swap;
  src: url(Roboto-Regular.ttf) format('ttf');
}

@font-face {
  font-family: 'Ubuntu Mono';
  font-weight: 700;
  font-style: normal;
  font-display: swap;
  src: url(UbuntuMono-Bold.ttf) format('ttf');
}

index.js:

import fs from 'node:fs/promises'
import { join } from 'node:path'
import postcss from 'postcss'
import postcssFontpie from 'postcss-fontpie'

const inputPath = `input.css`
const inputCss = await fs.readFile(inputPath, `utf8`)

const outputPath = `output.css`
const outputCss = (
  await postcss([
    postcssFontpie({
      // A mapping from `font-family` to its font type (`sans-serif`, `serif`, or `mono`).
      fontTypes: {
        'Noto Serif': `serif`,
        Roboto: `sans-serif`,
        'Ubuntu Mono': `mono`,
      },

      // An optional function that transforms a font face to a path to the font
      // file.
      resolveFilename: fontFace => join(`./path/to/fonts`, fontFace.src),
    }),
  ]).process(css, { from: inputPath, to: outputPath })
).css
await fs.writeFile(outputPath, outputCss)

output.css:

@font-face {
  font-family: 'Noto Serif Fallback';
  font-style: italic;
  font-weight: 400;
  src: local(Times New Roman Italic);
  ascent-override: 91.94%;
  descent-override: 25.2%;
  line-gap-override: 0%;
  size-adjust: 116.25%;
}

@font-face {
  font-family: 'Noto Serif';
  font-weight: 400;
  font-style: italic;
  font-display: swap;
  src: url(NotoSerif-Italic.ttf) format('ttf');
}

@font-face {
  font-family: 'Roboto Fallback';
  font-style: normal;
  font-weight: 400;
  src: local(Arial);
  ascent-override: 92.49%;
  descent-override: 24.34%;
  line-gap-override: 0%;
  size-adjust: 100.3%;
}

@font-face {
  font-family: 'Roboto';
  font-weight: 400;
  font-style: normal;
  font-display: swap;
  src: url(Roboto-Regular.ttf) format('ttf');
}

@font-face {
  font-family: 'Ubuntu Mono Fallback';
  font-style: normal;
  font-weight: 700;
  src: local(Courier New Bold);
  ascent-override: 99.62%;
  descent-override: 20.4%;
  line-gap-override: 0%;
  size-adjust: 83.32%;
}

@font-face {
  font-family: 'Ubuntu Mono';
  font-weight: 700;
  font-style: normal;
  font-display: swap;
  src: url(UbuntuMono-Bold.ttf) format('ttf');
}

The plugin can also be used in postcss.config.js. See fontpie for font format support and browser compatibility.

Contributing

Stars are always welcome!

For bugs and feature requests, please create an issue.

For pull requests, please read the contributing guidelines.

License

Apache License 2.0

This is not an official Google product.

postcss-fontpie's People

Contributors

romainmenke avatar tomeraberbach avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar

Forkers

romainmenke mishamyrt

postcss-fontpie's Issues

Add option to suppress 'Missing font type mapping' warnings

While trying to integrate this plugin in an Astro project, the parameter provided by srcUrlToFilename couldn’t be used, as sometimes, the url has a format similar to .__VITE_ASSET__abcd1234__.

In order to mitigate the issue, I came up with the idea of including the plugin twice and returning a static path via srcUrlToFilename. However, the following postcss.config.cjs produces unwanted 'Missing font type mapping' warnings as a result:

const postcssFontpie = require("postcss-fontpie");

const atkinsonHyperlegibleFilename = require.resolve(
  "@fontsource/atkinson-hyperlegible/files/atkinson-hyperlegible-latin-400-normal.woff2",
);
const jetBrainsMonoFilename = require.resolve(
  "@fontsource/jetbrains-mono/files/jetbrains-mono-latin-400-normal.woff2",
);

module.exports = {
  plugins: [
    postcssFontpie({
      fontTypes: { "Atkinson Hyperlegible": "sans-serif" },
      srcUrlToFilename: () => atkinsonHyperlegibleFilename,
    }),
    postcssFontpie({
      fontTypes: { "JetBrains Mono": "mono" },
      srcUrlToFilename: () => jetBrainsMonoFilename,
    }),
  ],
};

I’d propose an option to suppress such warnings as a mitigation.

Make filename retrieval function more generic

In some occasions mentioned in #6, the src within @font-face declarations can’t be used for mapping to a filename.

I’d propose adding a more generic resolveFilename callback as a replacement for srcUrlToFilename, accepting parameters such as src and fontFamily:

const postcssFontpie = require("postcss-fontpie");

module.exports = {
  plugins: [
    postcssFontpie({
      fontTypes: {
        "Atkinson Hyperlegible": "sans-serif",
        "JetBrains Mono": "mono",
      },
      resolveFilename: ({ src: _unused, fontFamily }) => {
        const fontFamilyNormalized = fontFamily.replace(" ", "-").toLowerCase();
        return require.resolve(
          `@fontsource/${fontFamilyNormalized}/files/${fontFamilyNormalized}-latin-400-normal.woff2`,
        );
      },
    }),
  ],
};

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.