@prosperitainova/dumbo-react-native
Version:
Dumbo for React Native Library
210 lines • 6.25 kB
TypeScript
/**
* This file includes all the exported typography styles. These are auto used by the `Text` component.
* You can use them directly for any other text styles.
* This repo includes only the fonts used directly.
* If you want to use other fonts you can download them and store them in your app and follow same directions on README.
*/
/** Font weights supported */
export type FontWeights = 'normal' | 'bold' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900' | undefined;
/** Declaration of standard Font item */
export type FontDefinition = {
fontWeight: FontWeights;
fontFamily: string;
};
/** Font override type */
export type FontDefinitionOverrides = {
light?: FontDefinition;
regular?: FontDefinition;
semiBold?: FontDefinition;
monoRegular?: FontDefinition;
};
/**
* Override internal font groups. By default Carbon uses Plex.
* You can override with your own font family here. You can choose to only override some or all.
* You must install the fonts and setup React Native to bundle your custom font family if not using an available system font.
*
* @param overrides - The font sets the app use internally
*/
export declare const overrideFonts: (overrides: FontDefinitionOverrides) => void;
/**
* Indicate if font scaling is on
* @returns boolean indicating if font scaling is in use
*/
export declare const fontScalingActive: () => boolean;
/** Font light styling */
export declare const LightFont: () => FontDefinition;
/** Font regular styling */
export declare const RegularFont: () => FontDefinition;
/** Font semi-bold styling */
export declare const SemiBoldFont: () => FontDefinition;
/** Font Mono regular styling */
export declare const MonoRegularFont: () => FontDefinition;
/** Code-01 text style (Productive) */
export declare const Code01: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Code-02 text style (Expressive) */
export declare const Code02: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Label-01 text style (Productive) */
export declare const Label01: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Label-02 text style (Expressive) */
export declare const Label02: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Helper-text-01 text style (Productive) */
export declare const HelperText01: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Helper-text-02 text style (Expressive) */
export declare const HelperText02: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Legal-01 text style (Productive) */
export declare const Legal01: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Legal-02 text style (Expressive) */
export declare const Legal02: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Body-compact-01 text style (Productive) */
export declare const BodyCompact01: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Body-compact-02 text style (Expressive) */
export declare const BodyCompact02: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Body-01 text style (Productive) */
export declare const Body01: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Body-02 text style (Expressive) */
export declare const Body02: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Heading-compact-01 text style (Productive) */
export declare const HeadingCompact01: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Heading-compact-02 text style (Expressive) */
export declare const HeadingCompact02: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Heading-01 text style (Productive) */
export declare const Heading01: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Heading-02 text style (Expressive) */
export declare const Heading02: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Heading-03 text style (Productive) */
export declare const Heading03: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Heading-04 text style (Productive) */
export declare const Heading04: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Heading-05 text style (Productive) */
export declare const Heading05: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Heading-06 text style (Productive) */
export declare const Heading06: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
/** Heading-07 text style (Productive) */
export declare const Heading07: () => {
fontWeight: FontWeights;
fontFamily: string;
fontSize: number;
lineHeight: number;
letterSpacing: number;
};
//# sourceMappingURL=typography.d.ts.map