Skip to content
Edit this page

Typography API

API reference docs for the React Typography component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Typography from '@mui/joy/Typography';
// or
import { Typography } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

children

The content of the component.

Type:

node
color

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
endDecorator

Element placed after the children.

Type:

node
gutterBottom

If true, the text will have a bottom margin.

Type:

bool

Default:

false
level

Applies the theme typography styles.

Type:

'h1' | 'h2' | 'h3' | 'h4' | 'title-lg' | 'title-md' | 'title-sm' | 'body-lg' | 'body-md' | 'body-sm' | 'body-xs' | 'inherit' | string

Default:

'body-md'
levelMapping

The component maps the variant prop to a range of different HTML element types. For instance, body1 to <h6>. If you wish to change that mapping, you can provide your own. Alternatively, you can use the component prop.

Type:

object

Default:

{ h1: 'h1', h2: 'h2', h3: 'h3', h4: 'h4', 'title-lg': 'p', 'title-md': 'p', 'title-sm': 'p', 'body-lg': 'p', 'body-md': 'p', 'body-sm': 'p', 'body-xs': 'span', inherit: 'p', }
noWrap

If true, the text will not wrap, but instead will truncate with a text overflow ellipsis.
Note that text overflow can only happen with block or inline-block level elements (the element needs to have a width in order to overflow).

Type:

bool

Default:

false
slotProps

The props used for each slot inside.

Type:

{ endDecorator?: func | object, root?: func | object, startDecorator?: func | object }

Default:

{}
slots

The components used for each slot inside.

See Slots API below for more details.

Type:

{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }

Default:

{}
startDecorator

Element placed before the children.

Type:

node
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
textColor

The system color.

Type:

any
variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string
As a CSS utility, the Typography component also supports all system properties. You can use them as props directly on the component.

The ref is forwarded to the root element.

Theme default props

You can use JoyTypography to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root

The component that renders the root.

Default: 'a'

Global class: .MuiTypography-root

startDecorator

The component that renders the start decorator.

Default: 'span'

Global class: .MuiTypography-startDecorator

endDecorator

The component that renders the end decorator.

Default: 'span'

Global class: .MuiTypography-endDecorator

You can override the style of the component using one of these customization options:

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.MuiTypography-body-lg

Class name applied to the root element if level="body-lg".

.MuiTypography-body-md

Class name applied to the root element if level="body-md".

.MuiTypography-body-sm

Class name applied to the root element if level="body-sm".

.MuiTypography-body-xs

Class name applied to the root element if level="body-xs".

.MuiTypography-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiTypography-colorDanger

Class name applied to the root element if color="danger".

.MuiTypography-colorNeutral

Class name applied to the root element if color="neutral".

.MuiTypography-colorPrimary

Class name applied to the root element if color="primary".

.MuiTypography-colorSuccess

Class name applied to the root element if color="success".

.MuiTypography-colorWarning

Class name applied to the root element if color="warning".

.MuiTypography-gutterBottom

Class name applied to the root element if gutterBottom={true}.

.MuiTypography-h1

Class name applied to the root element if level="h1".

.MuiTypography-h2

Class name applied to the root element if level="h2".

.MuiTypography-h3

Class name applied to the root element if level="h3".

.MuiTypography-h4

Class name applied to the root element if level="h4".

.MuiTypography-noWrap

Class name applied to the root element if nowrap={true}.

.MuiTypography-title-lg

Class name applied to the root element if level="title-lg".

.MuiTypography-title-md

Class name applied to the root element if level="title-md".

.MuiTypography-title-sm

Class name applied to the root element if level="title-sm".

.MuiTypography-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiTypography-variantPlain

Class name applied to the root element if variant="plain".

.MuiTypography-variantSoft

Class name applied to the root element if variant="soft".

.MuiTypography-variantSolid

Class name applied to the root element if variant="solid".