0.0.1 • Published 3 years ago

gfont-apply v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

\

This webcomponent follows the open-wc recommendation.

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

Note: You are required to supply either an array of font families that are valid google fonts, or a google font API key

Fonts

Array of valid font families you want to be available in the autocomplete. Should follow this typing

interface Font {
  family: string;
}

Example

import fonts from './myfonts.json';
<gfont-apply .fonts=${fonts}>
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque cursus. 
</gfont-apply>

API Key

To dynamically download a list of fonts from Google Fonts, you can use their API after generating an API key

<gfont-apply .apiKey="KEY_HERE">
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque cursus. 
</gfont-apply>

Show

Show or hides the autocomplete element

<gfont-apply .show=${false}>
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque cursus. 
</gfont-apply>

MaxResults

To extend or reduce the number of items shown in the autocomplete

<gfont-apply .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