@types/webfontloader
- Version 1.6.38
- Published
- 6.96 kB
- No dependencies
- MIT license
Install
npm i @types/webfontloader
yarn add @types/webfontloader
pnpm add @types/webfontloader
Overview
TypeScript definitions for webfontloader
Index
Functions
function load
load: (config: WebFont.Config) => void;
Interfaces
interface Config
interface Config {}
property classes
classes?: boolean | undefined;
Setting this to false will disable html classes (defaults to true)
property context
context?: Window | undefined;
Child window or iframe to manage fonts for
property custom
custom?: Custom | undefined;
property events
events?: boolean | undefined;
Settings this to false will disable callbacks/events (defaults to true)
property fontdeck
fontdeck?: Fontdeck | undefined;
property google
google?: Google | undefined;
property monotype
monotype?: Monotype | undefined;
property timeout
timeout?: number | undefined;
Time (in ms) until the fontinactive callback will be triggered (defaults to 5000)
property typekit
typekit?: Typekit | undefined;
method active
active: () => void;
This event is triggered when the fonts have rendered.
method fontactive
fontactive: (familyName: string, fvd: string) => void;
This event is triggered once for each font that renders.
method fontinactive
fontinactive: (familyName: string, fvd: string) => void;
This event is triggered if the font can't be loaded.
method fontloading
fontloading: (familyName: string, fvd: string) => void;
This event is triggered once for each font that's loaded.
method inactive
inactive: () => void;
This event is triggered when the browser does not support linked fonts or if none of the fonts could be loaded.
method loading
loading: () => void;
This event is triggered when all fonts have been requested.
interface Custom
interface Custom {}
property families
families?: string[] | undefined;
property testStrings
testStrings?: { [fontFamily: string]: string } | undefined;
property urls
urls?: string[] | undefined;
interface Google
interface Google {}
interface Monotype
interface Monotype {}
property loadAllFonts
loadAllFonts?: boolean | undefined;
property projectId
projectId?: string | undefined;
property version
version?: number | undefined;
Package Files (1)
Dependencies (0)
No dependencies.
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/webfontloader
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/webfontloader)
- HTML<a href="https://www.jsdocs.io/package/@types/webfontloader"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2624 ms. - Missing or incorrect documentation? Open an issue for this package.