https://github.com/unjs/unifont

Framework agnostic tools for accessing data from font CDNs and providers
https://github.com/unjs/unifont

font performance

Last synced: about 2 months ago
JSON representation

Framework agnostic tools for accessing data from font CDNs and providers

• Host: GitHub
• URL: https://github.com/unjs/unifont
• Owner: unjs
• License: mit
• Created: 2024-04-26T08:50:04.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-11-29T10:05:04.000Z (2 months ago)
• Last Synced: 2024-11-29T11:22:47.156Z (2 months ago)
• Topics: font, performance
• Language: TypeScript
• Homepage:
• Size: 718 KB
• Stars: 172
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# unifont

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Github Actions][github-actions-src]][github-actions-href]

[![Codecov][codecov-src]][codecov-href]

> Framework agnostic tools for accessing data from font CDNs and providers

## Usage

Install package:

```sh

# npm

npm install unifont

```

```js

import { createUnifont, providers } from 'unifont'

const unifont = await createUnifont([

  providers.google(),

])

const fonts = await unifont.resolveFont('Poppins')

console.log(fonts)

```

In most environments, you will want to cache the results of font APIs to avoid unnecessary hits to them. By default `unifont` caches font data in memory.

For full control, `unifont` exposes a storage API which is compatible with `unstorage`. It simply needs to expose a `getItem` and `setItem` method.

```ts

import { createUnifont, providers } from 'unifont'

import { createStorage } from 'unstorage'

import fsDriver from 'unstorage/drivers/fs-lite'

const storage = createStorage({

  driver: fsDriver({ base: 'node_modules/.cache/unifont' }),

})

const cachedUnifont = await createUnifont([providers.google()], { storage })

console.log(await cachedUnifont.resolveFont('Poppins'))

// cached data is stored in `node_modules/.cache/unifont`

```

For more about the storage drivers exposed from `unstorage`, check out https://unstorage.unjs.io.

## 💻 Development

- Clone this repository

- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`

- Install dependencies using `pnpm install`

- Run interactive tests using `pnpm dev`

## License

Made with ❤️

Published under [MIT License](./LICENCE).

[npm-version-src]: https://img.shields.io/npm/v/unifont?style=flat-square

[npm-version-href]: https://npmjs.com/package/unifont

[npm-downloads-src]: https://img.shields.io/npm/dm/unifont?style=flat-square

[npm-downloads-href]: https://npm.chart.dev/unifont

[github-actions-src]: https://img.shields.io/github/actions/workflow/status/unjs/unifont/ci.yml?branch=main&style=flat-square

[github-actions-href]: https://github.com/unjs/unifont/actions?query=workflow%3Aci

[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/unifont/main?style=flat-square

[codecov-href]: https://codecov.io/gh/unjs/unifont