UNPKG

2.1 kBMarkdownView Raw
1# parse-css-font
2
3[![NPM version](http://img.shields.io/npm/v/parse-css-font.svg?style=flat)](https://www.npmjs.org/package/parse-css-font)
4[![npm license](http://img.shields.io/npm/l/parse-css-font.svg?style=flat-square)](https://www.npmjs.org/package/parse-css-font)
5[![Travis Build Status](https://img.shields.io/travis/jedmao/parse-css-font.svg)](https://travis-ci.org/jedmao/parse-css-font)
6[![codecov](https://codecov.io/gh/jedmao/parse-css-font/branch/master/graph/badge.svg)](https://codecov.io/gh/jedmao/parse-css-font)
7[![BundlePhobia Minified](https://badgen.net/bundlephobia/min/parse-css-font?label=min)](https://bundlephobia.com/result?p=parse-css-font)
8[![BundlePhobia Minified + gzip](https://badgen.net/bundlephobia/minzip/parse-css-font?label=min%2Bgzip)](https://bundlephobia.com/result?p=parse-css-font)
9[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
10[![Unicorn Approved](https://img.shields.io/badge/unicorn-approved-ff69b4.svg)](https://twitter.com/sindresorhus/status/457989012528316416?ref_src=twsrc%5Etfw&ref_url=https%3A%2F%2Fwww.quora.com%2FWhat-does-the-unicorn-approved-shield-mean-in-GitHub)
11
12[![npm](https://nodei.co/npm/parse-css-font.svg?downloads=true)](https://nodei.co/npm/parse-css-font/)
13
14Parses the CSS [font property](https://developer.mozilla.org/en-US/docs/Web/CSS/font#font-variant-css21).
15
16## Installation
17
18```
19$ npm install parse-css-font [--save[-dev]]
20```
21
22## Usage
23
24```js
25const parseCSSFont = require('parse-css-font')
26parseCSSFont('1rem "Roboto Condensed", sans-serif;')
27/*
28{
29 size: '1rem',
30 family: ['Roboto Condensed', 'sans-serif'],
31 style: 'normal',
32 variant: 'normal',
33 weight: 'normal',
34 stretch: 'normal',
35 lineHeight: 'normal'
36}
37*/
38```
39
40See [the tests](https://github.com/jedmao/parse-css-font/blob/master/src/index.test.ts) for more scenarios.
41
42### ES6/2015 import
43
44```ts
45import parseCSSFont from 'parse-css-font'
46```
47
48## Testing
49
50```
51$ npm test
52```
53
54This will run tests and generate a code coverage report. Anything less than 100% coverage will throw an error.