Skip to content

Typography API

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

Demos

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.

NameTypeDefaultDescription
childrennode-

The content of the component.

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
-

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.

componentelementType-

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

endDecoratornode-

Element placed after the children.

gutterBottomboolfalse

If true, the text will have a bottom margin.

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

Applies the theme typography styles.

levelMappingobject{ 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', }

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.

noWrapboolfalse

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).

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

The props used for each slot inside.

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

The components used for each slot inside.

See Slots API below for more details.

startDecoratornode-

Element placed before the children.

sxArray<func
| object
| bool>
| func
| object
-

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

See the `sx` page for more details.

textColorany-

The system color.

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
-

The global variant to use.

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

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.

Slot nameClass nameDefault componentDescription
root.MuiTypography-root'a'The component that renders the root.
startDecorator.MuiTypography-startDecorator'span'The component that renders the start decorator.
endDecorator.MuiTypography-endDecorator'span'The component that renders the end decorator.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiTypography-body-lgbody-lgClass name applied to the root element if level="body-lg".
.MuiTypography-body-mdbody-mdClass name applied to the root element if level="body-md".
.MuiTypography-body-smbody-smClass name applied to the root element if level="body-sm".
.MuiTypography-body-xsbody-xsClass name applied to the root element if level="body-xs".
.MuiTypography-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiTypography-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiTypography-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiTypography-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiTypography-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiTypography-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiTypography-gutterBottomgutterBottomClass name applied to the root element if gutterBottom={true}.
.MuiTypography-h1h1Class name applied to the root element if level="h1".
.MuiTypography-h2h2Class name applied to the root element if level="h2".
.MuiTypography-h3h3Class name applied to the root element if level="h3".
.MuiTypography-h4h4Class name applied to the root element if level="h4".
.MuiTypography-noWrapnoWrapClass name applied to the root element if nowrap={true}.
.MuiTypography-title-lgtitle-lgClass name applied to the root element if level="title-lg".
.MuiTypography-title-mdtitle-mdClass name applied to the root element if level="title-md".
.MuiTypography-title-smtitle-smClass name applied to the root element if level="title-sm".
.MuiTypography-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined".
.MuiTypography-variantPlainvariantPlainClass name applied to the root element if variant="plain".
.MuiTypography-variantSoftvariantSoftClass name applied to the root element if variant="soft".
.MuiTypography-variantSolidvariantSolidClass name applied to the root element if variant="solid".

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.