24 lines
958 B
TypeScript
24 lines
958 B
TypeScript
import { UseFontHook } from './Font.types';
|
|
/**
|
|
* Load a map of fonts at runtime with [`loadAsync`](#loadasyncfontfamilyorfontmap-source). This returns `true` if the fonts are
|
|
* loaded and ready to use. It also returns an error if something went wrong, to use in development.
|
|
*
|
|
* > Note, the fonts are not "reloaded" when you dynamically change the font map.
|
|
*
|
|
* @param map A map of `fontFamily`s to [`FontSource`](#fontsource)s. After loading the font you can
|
|
* use the key in the `fontFamily` style prop of a `Text` element.
|
|
*
|
|
* @return
|
|
* - __loaded__ (`boolean`) - A boolean to detect if the font for `fontFamily` has finished
|
|
* loading.
|
|
* - __error__ (`Error | null`) - An error encountered when loading the fonts.
|
|
*
|
|
* @example
|
|
* ```tsx
|
|
* const [loaded, error] = useFonts({
|
|
* 'Inter-Black': require('./assets/fonts/Inter-Black.otf'),
|
|
* });
|
|
* ```
|
|
*/
|
|
export declare const useFonts: UseFontHook;
|
|
//# sourceMappingURL=FontHooks.d.ts.map
|