A small utility to efficiently load custom web fonts
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
font
scripts
test
.eslintignore
.eslintrc
.gitignore
.travis.yml
LICENSE
README.md
browser.json
karma.conf.js
marko.json
package.json

README.md

ebay-font Build Status

ebay-font is the module used at eBay to load custom web fonts. It uses a strategy to avoid both FOUT and FOIT. This can be considered equivalent to the new CSS @font-face descriptor font-display: optional. Unfortunately, font-display is relatively new and hence its adoption among browsers is not widespread. So for now, this module leverages localStorage, FontFaceSet API and the Font Face Observer utility (as a backup if FontFaceSet API is not present) to provide the same functionality as font-display: optional.

ebay-font is paired along with eBay's custom font 'Market Sans'. But feel free to change it to any custom font URL of your choice.

Please refer to the detailed blog post "eBay’s Font Loading Strategy" for a full overview of how this module works.

Usage

ebay-font can be used along with other eBay open source modules Skin, Marko & Lasso, as well as in standalone mode. If you are in the eBay workflow environment, please follow the below steps

  1. Install and save the module
npm install ebay-font --save
  1. Add dependency in your page browser.json
"ebay-font/browser.json"
  1. The module exposes a tag <ebay-font> to embed in the <head> tag of page HTML
<html>
<head>
    <ebay-font/>
    ... 
</head>
...
</html>
  • Note: If your website uses Content Security Policy (CSP), you can pass the CSP nonce value to <ebay-font> tag
...
    <ebay-font nonce="4AEemGb0xJptoIGFP3Nd"/>
...

Standalone

  1. Copy paste this CSS and JavaScript tag snippet in the <head> tag of your page

  2. Include the generated JavaScript file fontloader.standalone.js in the footer

<script async src="fontloader.standalone.js"></script>

Browser support

  • Chrome (desktop & Android)
  • Firefox
  • Opera
  • Safari (desktop & iOS)
  • IE8+
  • Android WebKit

Issues

Have a bug or a feature request? Please open a new issue

Open browser issues

  • Chrome — Very randomly on a new session, all font formats are getting downloaded if font-display is present in the font-face. Filed a bug to track it.

Maintainers

Contribute

Pull Requests welcome. Please submit Github issues for any feature enhancements, bugs or documentation problems.

License

Copyright (c) 2017 eBay Inc.

Released under the MIT License