liber-salti/build/Typography/Typography.types.d.ts

Saltí - Liber Design System

/// <reference types="react" />
import { TypographyClassKey } from '@mui/material/Typography';
import { ClassNameMap } from '@mui/styles';
export declare type Alignment = 'inherit' | 'left' | 'center' | 'right' | 'justify';
export declare type TypographyVariant = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'subtitle1' | 'subtitle2' | 'body1' | 'body2' | 'caption' | 'overline';
export interface TypographyProps {
    /**
     * The text to be displayed
     */
    children?: React.ReactNode;
    /**
     * Text alignment
     */
    align?: Alignment;
    /**
     * Text color
     */
    color?: 'initial' | 'inherit' | 'primary' | 'textPrimary' | 'textSecondary' | 'error';
    /**
     * CSS display property
     */
    display?: 'initial' | 'block' | 'inline';
    /**
     * Some space in the bottom if the text
     */
    gutterBottom?: boolean;
    /**
     * Don't wrap the text?
     */
    noWrap?: boolean;
    /**
     * Text is a paragraph?
     */
    paragraph?: boolean;
    /**
     * Which kind of text it is
     */
    variant?: TypographyVariant | 'inherit';
    /**
     * Use monospaced font. Used for numbers or code snippets.
     * Not available for caption, overline, subtitle1 and subtitle2.
     */
    monospaced?: boolean;
    /**
     * Overridabled classes
     */
    classes?: Partial<ClassNameMap<TypographyClassKey>>;
}