{"id":20186778,"url":"https://github.com/cloakedninjas/phaser3-webfont-loader","last_synced_at":"2025-04-10T06:30:27.519Z","repository":{"id":42711046,"uuid":"270101321","full_name":"cloakedninjas/phaser3-webfont-loader","owner":"cloakedninjas","description":"Phaser 3 Webfont Loader","archived":false,"fork":false,"pushed_at":"2023-01-07T18:53:03.000Z","size":188,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-14T22:13:42.172Z","etag":null,"topics":["phaser","phaser-plugin","phaser3","typescript","webfonts"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloakedninjas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-06T20:52:55.000Z","updated_at":"2022-08-22T20:17:59.000Z","dependencies_parsed_at":"2023-02-07T21:31:30.897Z","dependency_job_id":null,"html_url":"https://github.com/cloakedninjas/phaser3-webfont-loader","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloakedninjas%2Fphaser3-webfont-loader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloakedninjas%2Fphaser3-webfont-loader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloakedninjas%2Fphaser3-webfont-loader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloakedninjas%2Fphaser3-webfont-loader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloakedninjas","download_url":"https://codeload.github.com/cloakedninjas/phaser3-webfont-loader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224557379,"owners_count":17331184,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["phaser","phaser-plugin","phaser3","typescript","webfonts"],"created_at":"2024-11-14T03:18:36.237Z","updated_at":"2024-11-14T03:18:36.697Z","avatar_url":"https://github.com/cloakedninjas.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Phaser 3 Webfont Loader\n\nA webfont loader for Phaser 3 that uses CSS `@font-face` to download the font and `FontFaceSet` to trigger / detect the load.\n\nIf the browser does not support `FontFaceSet` (see [compatability table](https://developer.mozilla.org/en-US/docs/Web/API/FontFaceSet/load#Browser_compatibility)) the loader will attempt to inject an invisible HTML element into the page to trigger the browser to download the font file. A delay of 50ms is waited for before loading completes and the element removed. This delay is configurable in [Loader Config](#loader-config)\n\n## Installation\n\n```console\n$ npm install -D phaser3-webfont-loader\n```\n\n## Usage\n\n### Import the plugin\n\n```js\nimport { WebFontLoaderPlugin } from 'phaser3-webfont-loader';\n```\n\n### Load the plugin\n\n```js\nnew Phaser.Game({\n  type: Phaser.AUTO,\n  parent: 'phaser-example',\n  width: 800,\n  height: 600,\n  scene: {\n    preload: preload,\n    create: create\n  },\n  plugins: {\n    global: [{\n      key: 'WebFontLoader',\n      plugin: WebFontLoaderPlugin,\n      start: true\n    }]\n  }\n});\n```\n\n### Load a font\n\n```js\nfunction preload() {\n  this.load.webfont('Open Sans', 'https://fonts.googleapis.com/css2?family=Open+Sans\u0026display=swap');\n}\n```\n\n### Use it\n\n```js\nfunction create() {\n  this.add.text(400, 300, 'Hello there', {\n    fontFamily: 'Open Sans',\n    fontSize: '12px'\n  });\n}\n```\n\nSee [a working example](https://cloakedninjas.github.io/phaser3-webfont-loader)\n\n## Fonts with multiple variants\n\n```js\nfunction preload() {\n  this.load.webfont({\n    font: 'Roboto',\n    variants: [\n      'normal',\n      '100',\n      '700',\n      '700 italic'\n    ]\n  }, 'https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,500;1,400;1,700\u0026display=swap');\n}\n\nfunction create() {\n  this.add.text(400, 300, 'Hello there', {\n    fontFamily: 'Roboto',\n    fontSize: '12px',\n    fontStyle: '700 italic'\n  });\n}\n```\n\n\n## Loader Config\n\n\n| config | description | default |\n|--|--|--|\n| testString | 2nd argument for `FontFaceSet.load()`| \"\" |\n| legacyTimeout | Time (in ms) to wait before sending success callback to Phaser Loader| 50 |\n\n\n```js\nthis.load.webfont('Open Sans', 'https://fonts.googleapis.com/css2?family=Open+Sans\u0026display=swap', {\n  testString: 'Text Here',\n  legacyTimeout: 100\n});\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloakedninjas%2Fphaser3-webfont-loader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloakedninjas%2Fphaser3-webfont-loader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloakedninjas%2Fphaser3-webfont-loader/lists"}