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.

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

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.

Class name: .MuiTypography-root

Default component: 'a'


startDecorator

The component that renders the start decorator.

Class name: .MuiTypography-startDecorator

Default component: 'span'


endDecorator

The component that renders the end decorator.

Class name: .MuiTypography-endDecorator

Default component: 'span'


CSS classes

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

.MuiTypography-body-lg

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

Rule name:body-lg


.MuiTypography-body-md

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

Rule name:body-md


.MuiTypography-body-sm

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

Rule name:body-sm


.MuiTypography-body-xs

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

Rule name:body-xs


.MuiTypography-colorContext

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

Rule name:colorContext


.MuiTypography-colorDanger

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

Rule name:colorDanger


.MuiTypography-colorNeutral

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

Rule name:colorNeutral


.MuiTypography-colorPrimary

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

Rule name:colorPrimary


.MuiTypography-colorSuccess

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

Rule name:colorSuccess


.MuiTypography-colorWarning

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

Rule name:colorWarning


.MuiTypography-gutterBottom

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

Rule name:gutterBottom


.MuiTypography-h1

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

Rule name:h1


.MuiTypography-h2

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

Rule name:h2


.MuiTypography-h3

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

Rule name:h3


.MuiTypography-h4

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

Rule name:h4


.MuiTypography-noWrap

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

Rule name:noWrap


.MuiTypography-title-lg

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

Rule name:title-lg


.MuiTypography-title-md

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

Rule name:title-md


.MuiTypography-title-sm

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

Rule name:title-sm


.MuiTypography-variantOutlined

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

Rule name:variantOutlined


.MuiTypography-variantPlain

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

Rule name:variantPlain


.MuiTypography-variantSoft

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

Rule name:variantSoft


.MuiTypography-variantSolid

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

Rule name:variantSolid



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

Edit this page

Was this page helpful?


TooltipApproaches

Blog

Store