Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 1.56 KB

README.md

File metadata and controls

70 lines (48 loc) · 1.56 KB
Raw

<gfont-apply>

Search for available google fonts and apply it to your content. Great way to quickly try out lots of different fonts and find the right one for your content

font-apply

Demo

Installation

npm i gfont-apply

Usage

<script type="module">
  import 'gfont-apply/gfont-apply.js';
</script>

<gfont-apply>
  This is where you put the content you want to be able to update the font for
</gfont-apply>

Configuration

You are required to supply either an array of font families that are valid google fonts, or a google font API key. See src/fonts.js for an example on how the fonts should be formatted.

<gfont-apply
  <!-- An array of font families. See index.html for an example. REQUIRED if google fonts API key is not supplied -->
  .fonts=${fonts}

  <!-- Google fonts API key. REQUIRED if the fonts array above is not set -->
  .apiKey="KEY_HERE"

  <!-- Show the autocomplete element. Defaults to true -->
  .show=${false}

  <!-- Number of items to show in autocomplete results. Defaults to 4 -->
  .maxItems="10">
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque cursus. 
</gfont-apply>

Development

Linting and formatting

To scan the project for linting and formatting errors, run

npm run lint

To automatically fix linting and formatting errors, run

npm run format

Running

npm start