Theme typography
Learn about the typography system and how to customize it.
Joy UI includes a typography system within the theme to help you create consistent text across your application. You can customize the default system or start from scratch depending on your needs.
Default system
The default system consists of 13 built-in levels:
body1
- the baseline typography for the application, used as the default configuration in the Typography and CssBaseline components.body2
throughbody5
- can be used for secondary and tertiary information.- The
h1
toh6
levels follow the semantic HTML headings. - The
display1
anddisplay2
usually appear as taglines for marketing and landing pages.
Level | Color | Font size | Font weight | Line height | Letter spacing |
---|---|---|---|---|---|
display1 | var(--joy-palette-text-primary) | var(--joy-fontSize-xl7) | var(--joy-fontWeight-xl) | var(--joy-lineHeight-sm) | var(--joy-letterSpacing-sm) |
display2 | var(--joy-palette-text-primary) | var(--joy-fontSize-xl6) | var(--joy-fontWeight-xl) | var(--joy-lineHeight-sm) | var(--joy-letterSpacing-sm) |
h1 | var(--joy-palette-text-primary) | var(--joy-fontSize-xl5) | var(--joy-fontWeight-lg) | var(--joy-lineHeight-sm) | var(--joy-letterSpacing-sm) |
h2 | var(--joy-palette-text-primary) | var(--joy-fontSize-xl4) | var(--joy-fontWeight-lg) | var(--joy-lineHeight-sm) | var(--joy-letterSpacing-sm) |
h3 | var(--joy-palette-text-primary) | var(--joy-fontSize-xl3) | var(--joy-fontWeight-md) | var(--joy-lineHeight-sm) | - |
h4 | var(--joy-palette-text-primary) | var(--joy-fontSize-xl2) | var(--joy-fontWeight-md) | var(--joy-lineHeight-md) | - |
h5 | var(--joy-palette-text-primary) | var(--joy-fontSize-xl) | var(--joy-fontWeight-md) | var(--joy-lineHeight-md) | - |
h6 | var(--joy-palette-text-primary) | var(--joy-fontSize-lg) | var(--joy-fontWeight-md) | var(--joy-lineHeight-md) | - |
body1 | var(--joy-palette-text-primary) | var(--joy-fontSize-md) | - | var(--joy-lineHeight-md) | - |
body2 | var(--joy-palette-text-secondary) | var(--joy-fontSize-sm) | - | var(--joy-lineHeight-md) | - |
body3 | var(--joy-palette-text-tertiary) | var(--joy-fontSize-xs) | - | var(--joy-lineHeight-md) | - |
body4 | var(--joy-palette-text-tertiary) | var(--joy-fontSize-xs2) | - | var(--joy-lineHeight-md) | - |
body5 | var(--joy-palette-text-tertiary) | var(--joy-fontSize-xs3) | - | var(--joy-lineHeight-md) | - |
Customizing the default system
To customize a default level, provide its name as a key and an object containing CSS rules as a value to theme.typography
.
The example below illustrates the customization of the display1
level:
Removing the default system
Use undefined
as a value to remove any unneeded levels:
const customTheme = extendTheme({
typography: {
h5: undefined,
h6: undefined,
body4: undefined,
body5: undefined,
},
});
For TypeScript, you must augment the theme structure to exclude the default levels:
// You can put this to any file that's included in your tsconfig
declare module '@mui/joy/styles' {
interface TypographySystemOverrides {
h5: false;
h6: false;
body4: false;
body5: false;
}
}
Adding more levels
You can define a new level as a key-value pair in theme.typography
, where the key is the name of the level and the value is an object containing CSS rules.
The demo below shows how to add a new level called kbd
:
Press ⌘ + k to search the documentation.
For TypeScript, you must augment the theme structure to include the new level:
// You can put this to any file that's included in your tsconfig
declare module '@mui/joy/styles' {
interface TypographySystemOverrides {
kbd: true;
}
}
Usage
There are several ways that you can use the theme typography in your application:
Typography component: use the
level
prop to change between theme typography levels:// use the `theme.typography.body2` styles <Typography level="body2">Secondary info</Typography>
CSS Baseline component: by default, it applies the
body1
level to the global stylesheet:<CssBaseline /> // inherits the `theme.typography.body1` styles <p>Hello World</p>
sx
prop: usetypography: $level
to get the specific theme typography level:// to apply the `theme.typography.body2` styles: <Box sx={{ typography: 'body2' }}>Small text</Box>
styled
: create a custom component and apply the style fromtheme.typography.*
directly:import { styled } from '@mui/joy/styles'; const Tag = styled('span')((theme) => ({ ...theme.typography.body2, color: 'inherit', borderRadius: theme.vars.radius.xs, boxShadow: theme.vars.shadow.sm, padding: '0.125em 0.375em', }));
Common examples
Here is a collection of well-known typography systems that you can use with Joy UI.
Fluent (Microsoft)
Human Interface Guidelines (Apple)
- Design resource: Sketch library
- Font: San Francisco (SF)