Typography API
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';
Props
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
children | node | The content of the component. | |
color | 'danger' | 'info' | '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. | |
component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
endDecorator | node | Element placed after the children. | |
gutterBottom | bool | false | If true , the text will have a bottom margin. |
level | 'body1' | 'body2' | 'body3' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'inherit' | string | 'body1' | Applies the theme typography styles. |
levelMapping | object | { h1: 'h1', h2: 'h2', h3: 'h3', h4: 'h4', h5: 'h5', h6: 'h6', body1: 'p', body2: 'p', body3: 'p', 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. |
noWrap | bool | false | 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. |
startDecorator | node | Element placed before the children. | |
sx | Array<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. | |
textColor | any | 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 useJoyTypography
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.
Name | Default class | Default HTML tag | Description |
---|---|---|---|
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. |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.
CSS classes
These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.
Global class | Description |
---|---|
.MuiTypography-body1 | Class name applied to the root element if level="body1" . |
.MuiTypography-body2 | Class name applied to the root element if level="body2" . |
.MuiTypography-body3 | Class name applied to the root element if level="body3" . |
.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-colorInfo | Class name applied to the root element if color="info" . |
.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-h5 | Class name applied to the root element if level="h5" . |
.MuiTypography-h6 | Class name applied to the root element if level="h6" . |
.MuiTypography-noWrap | Class name applied to the root element if nowrap={true} . |
.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" . |