fontaine

Фонтейн

Автоматическое отступление шрифтов на основе метрик шрифтов

• Изменение
• ▶ ️ Онлайн -игровая площадка

Функции

• ? Снижает CLS, используя локальные запасные шрифты с изготовленными метриками шрифтов.
• Генерирует метрики шрифта и автоматически переопределяется.
• ⚡ Pure CSS, нулевое время выполнения.

В проекте Playground, включение / отключение fontaine делает следующую разницу рендеринг / , без необходимости настройки:

	До	После
CLS	0.24	0.054
Производительность	92	100

Установка

С pnpm

pnpm add -D fontaine

Или с npm

npm install -D fontaine

Или, с yarn

yarn add -D fontaine

Использование

 import { FontaineTransform } from 'fontaine'

// Astro config - astro.config.mjs
import { defineConfig } from 'astro/config'

const options = {
  fallbacks : [ 'BlinkMacSystemFont' , 'Segoe UI' , 'Helvetica Neue' , 'Arial' , 'Noto Sans' ] ,
  // You may need to resolve assets like `/fonts/Roboto.woff2` to a particular directory
  resolvePath : id => `file:///path/to/public/dir ${ id } ` ,
  // overrideName: (originalName) => `${name} override`
  // sourcemap: false
  // skipFontFaceGeneration: (fallbackName) => fallbackName === 'Roboto override'
}

// Vite
export default {
  plugins : [ FontaineTransform . vite ( options ) ]
}

// Next.js
export default {
  webpack ( config ) {
    config . plugins = config . plugins || [ ]
    config . plugins . push ( FontaineTransform . webpack ( options ) )
    return config
  } ,
}

// Docusaurus plugin - to be provided to the plugins option of docusaurus.config.js
// n.b. you'll likely need to require fontaine rather than importing it
const fontaine = require ( 'fontaine' )

function fontainePlugin ( _context , _options ) {
  return {
    name : 'fontaine-plugin' ,
    configureWebpack ( _config , _isServer ) {
      return {
        plugins : [
          fontaine . FontaineTransform . webpack ( options ) ,
        ] ,
      }
    } ,
  }
}

// Gatsby config - gatsby-node.js
const { FontaineTransform } = require ( 'fontaine' )

exports . onCreateWebpackConfig = ( { stage , actions , getConfig } ) => {
  const config = getConfig ( )
  config . plugins . push ( FontaineTransform . webpack ( options ) )
  actions . replaceWebpackConfig ( config )
}

export default defineConfig ( {
  integrations : [ ] ,
  vite : {
    plugins : [
      FontaineTransform . vite ( {
        fallbacks : [ 'Arial' ] ,
        resolvePath : id => new URL ( `./public ${ id } ` , import . meta . url ) , // id is the font src value in the CSS
      } ) ,
    ] ,
  } ,
} )

Примечание Если вы используете Nuxt, посетите Nuxt-Font-Metrics, которая использует fontaine под капотом.

Если ваш пользовательский шрифт используется с помощью механизма переменных CSS, вам нужно внести настройку переменных CSS, чтобы дать Фонтейну руку помощи. Docusaurus является примером этого, он использует переменную- --ifm-font-family-base для ссылки на пользовательский шрифт. Чтобы Fontaine могла подключить переменную с шрифтом, нам нужно добавить {Name of Font} override суффикс в эту переменную. Как это выглядит? Хорошо, представьте, что мы использовали пользовательские шрифты Poppins, на который ссылаются с переменной --ifm-font-family-base , мы сделали бы следующую корректировку:

:root {
  /* ... */
-  --ifm-font-family-base: 'Poppins';
+  --ifm-font-family-base: 'Poppins', 'Poppins override';

За кулисами существует правило «переопределения поппинса» @font-face которое было создано Фонтейном. Вручную добавляя это семейство Font Font в нашу переменную CSS, мы заставляем наш сайт использовать правило запасного @font-face с правильными показателями шрифтов, которые генерирует Фонтейн.

Как это работает

fontaine сканирует ваши правила @font-face и генерирует правила отступления с правильными показателями. Например:

 @font-face {
  font-family : 'Roboto' ;
  font-display : swap;
  src : url ( '/fonts/Roboto.woff2' ) format ( 'woff2' ) , url ( '/fonts/Roboto.woff' )
      format ( 'woff' );
  font-weight : 700 ;
}
/* This additional font-face declaration will be added to your CSS. */
@font-face {
  font-family : 'Roboto override' ;
  src : local ( 'BlinkMacSystemFont' ) , local ( 'Segoe UI' ) , local ( 'Helvetica Neue' ) ,
      local ( 'Arial' ) , local ( 'Noto Sans' );
  ascent-override : 92.7734375 % ;
  descent-override : 24.4140625 % ;
  line-gap-override : 0 % ;
}

Затем, когда вы используете font-family: 'Roboto' , fontaine добавит переопределение в семье шрифта:

 : root {
  font-family : 'Roboto' ;
  /* This becomes */
  font-family : 'Roboto' , 'Roboto override' ;
}

Разработка

• Клонировать это хранилище
• corepack enable Enable (используйте npm i -g corepack для node.js <16.10)
• Установите зависимости, используя pnpm install
• Запустите интерактивные тесты с помощью pnpm dev ; Запустите сервер Vite, используя исходный код с pnpm demo:dev

Кредиты

Это было бы невозможно без:

• Удивительные инструменты и сгенерированные метрики от Capsizecsss
• Предложение и алгоритм от Katie Hempenius & Kara Erickson в команде Google Aurora - см. Примечания по вычислению переопределения метрики шрифта
• Предложение по имени пакета от @clemcode

Лицензия

Сделано с ❤

Опубликовано по лицензии MIT.