ContextQMD
Back to Content

FontFaceSet

files/en-us/web/api/fontfaceset/index.md

latest3.0 KB
Original Source

{{APIRef("CSS Font Loading API")}}{{AvailableInWorkers}}

The FontFaceSet interface of the CSS Font Loading API manages the loading of font-faces and querying of their download status.

A FontFaceSet instance is a Set-like object that can hold an ordered set of {{domxref("FontFace")}} objects.

This property is available as {{domxref("Document.fonts")}}, or self.fonts in web workers.

{{InheritanceDiagram}}

Instance properties

  • {{domxref("FontFaceSet.status")}} {{ReadOnlyInline}}
    • : Indicates the font-face's loading status. It will be one of 'loading' or 'loaded'.
  • {{domxref("FontFaceSet.ready")}} {{ReadOnlyInline}}
    • : {{jsxref("Promise")}} which resolves once font loading and layout operations have completed.
  • {{domxref("FontFaceSet.size")}} {{ReadOnlyInline}}
    • : Returns the number of values in the FontFaceSet.

Events

  • {{domxref("FontFaceSet.loading_event", "loading")}}
    • : Fires when a font-face set has started loading.
  • {{domxref("FontFaceSet.loadingdone_event", "loadingdone")}}
    • : Fires when a font face set has finished loading.
  • {{domxref("FontFaceSet.loadingerror_event", "loadingerror")}}
    • : Fires when an error occurred whilst loading a font-face set.

Instance methods

  • {{domxref("FontFaceSet.add","FontFaceSet.add()")}}
    • : Adds a font to the font set.
  • {{domxref("FontFaceSet.check","FontFaceSet.check()")}}
    • : A boolean value that indicates whether a font is loaded, but doesn't initiate a load when it isn't.
  • {{domxref("FontFaceSet.clear", "FontFaceSet.clear()")}}
    • : Removes all manually-added fonts from the font set. CSS-connected fonts are unaffected.
  • {{domxref("FontFaceSet.delete","FontFaceSet.delete()")}}
    • : Removes a manually-added font from the font set. CSS-connected fonts are unaffected.
  • {{domxref("FontFaceSet.entries","FontFaceSet.entries()")}}
    • : Returns a new iterator with the values for each element in the FontFaceSet in insertion order.
  • {{domxref("FontFaceSet.forEach","FontFaceSet.forEach()")}}
    • : Executes a provided function for each value in the FontFaceSet object.
  • {{domxref("FontFaceSet.has","FontFaceSet.has()")}}
    • : Returns a {{jsxref("Boolean")}} asserting whether an element is present with the given value.
  • {{domxref("FontFaceSet.keys","FontFaceSet.keys()")}}
    • : An alias for {{domxref("FontFaceSet.values()")}}.
  • {{domxref("FontFaceSet.load","FontFaceSet.load()")}}
    • : Returns a {{jsxref("Promise")}} which resolves to a list of font-faces for a requested font.
  • {{domxref("FontFaceSet.values","FontFaceSet.values()")}}
    • : Returns a new iterator object that yields the values for each element in the FontFaceSet object in insertion order.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}