native-base/lib/typescript/hooks/useResolvedFontFamily.d.ts

Essential cross-platform UI components for React Native

import type { ITheme } from '../theme';
/**
 *
 * @param props
 * @returns resolved fontFamily
 * @description Combination of fontWeight, fontStyle and font family is fully supported on web but on Android we need to pass the exact font family.
 * for e.g. If we load Roboto-Light-Italic.ttf using css, we can use fontFamily: Roboto, fontWeight: 300, fontStyle: italic on web, but same may not work on all the platforms. Other platform needs to set fontFamily: Roboto-Light-Italic in order to work.
 * So this function's purpose is to intake styles like fontFamily: Roboto, fontWeight: 300, fontStyle: Italic and return fontFamily: Roboto-Light-Italic depending upon the fontConfig token in typography theme.
 * This function depends upon fontConfig token in typography for mapping.
 */
export declare function useResolvedFontFamily(props: {
    fontFamily?: keyof ITheme['fonts'];
    fontStyle?: string;
    fontWeight?: keyof ITheme['fontWeights'];
}): {
    fontFamily: "body" | "heading" | "mono" | undefined;
    fontWeight: "light" | "bold" | "black" | "medium" | "normal" | "hairline" | "thin" | "semibold" | "extrabold" | "extraBlack" | undefined;
    fontStyle: string | undefined;
};