2.2.0 • Published 3 days ago

@capsizecss/unpack v2.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 days ago

@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:

PropertyTypeDescription
familyNamestringFont family name as authored by font creator
capHeightnumberThe height of capital letters above the baseline
ascentnumberThe height of the ascenders above baseline
descentnumberThe descent of the descenders below baseline
lineGapnumberThe amount of space included between lines
unitsPerEmnumberThe size of the font’s internal coordinate grid
xHeightnumberThe height of lower case letters
xAvgCharWidthnumberThe average character width of all non-zero width characters

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.