Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@capsizecss/unpack

Package Overview
Dependencies
Maintainers
0
Versions
32
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@capsizecss/unpack

Unpack capsize font metrics from fonts

  • 2.3.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
54K
increased by1.74%
Maintainers
0
Weekly downloads
 
Created
Source
Capsize

@capsizecss/unpack

Unpack the capsize font metrics directly from a font file.

npm install @capsizecss/unpack
  • Usage
  • Options
  • Font Metrics

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);

Options

All of the above APIs accept an optional second parameter with the following options:

postscriptName

Capsize can extract the metrics for a single font from a TrueType Collection (TTC) file by providing the postscriptName.

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

const metrics = await fromFile('AvenirNext.ttc', {
  postscriptName: 'AvenirNext-Bold',
});

Font metrics

The font metrics object returned contains the following properties:

PropertyTypeDescription
familyNamestringThe font’s family name as authored by font creator
fullNamestringThe font’s full name as authored by font creator
postscriptNamestringThe font’s unique PostScript name as authored by font creator
categorystringThe style of the font: serif, sans-serif, monospace, display, or handwriting.
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 the main body of lower case letters above baseline
xWidthAvgnumberThe average width of character glyphs in the font for the selected unicode subset. Calculated based on character frequencies in written text, falling back to the built in xAvgCharWidth from the OS/2 table.
subsets{
[subset]: { xWidthAvg: number }
}
A lookup of the xWidthAvg metric by subset (see supported subsets)

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.

Keywords

FAQs

Package last updated on 29 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc