Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 2.14 KB

README.md

File metadata and controls

68 lines (45 loc) · 2.14 KB

Capsize


@capsizecss/unpack

Unpack the capsize font metrics directly from a font file.

npm install @capsizecss/unpack

Usage

fromBlob

Takes a file blob and returns the resolved font metrics.

import { fromBlob } from '@capsizecss/unpack';

const metrics = await fromBlob(file);

fromUrl

Takes a url string and returns the resolved font metrics.

import { fromUrl } from '@capsizecss/unpack';

const metrics = await fromUrl(url);

fromFile

Takes a file path string and returns the resolved font metrics.

import { fromFile } from '@capsizecss/unpack';

const metrics = await fromFile(filePath);

Font metrics

The font metrics object returned contains the following properties:

Property Type Description
familyName string Font family name as authored by font creator
fullName string Font full name as authored by font creator
postscriptName string Postscript name as authored by font creator
subfamilyName string Subfamily name as authored by font creator
capHeight number The height of capital letters above the baseline
ascent number The height of the ascenders above baseline
descent number The descent of the descenders below baseline
lineGap number The amount of space included between lines
unitsPerEm number The size of the font’s internal coordinate grid
xHeight number The height of lower case letters

Thanks

  • Devon Govett for creating Fontkit, which does all the heavy lifting of extracting the font metrics under the covers.
  • SEEK for giving us the space to do interesting work.

License

MIT.