@material/typography
Advanced tools
Typography classes, mixins, and variables for Material Components for the web
@material/typography is a package from the Material Design library that provides a set of typography styles and utilities to help developers implement consistent and visually appealing text styles in their web applications. It follows the Material Design guidelines for typography, ensuring that text elements are readable, accessible, and aesthetically pleasing.
Applying Typography Styles
This feature allows you to apply predefined typography styles to HTML elements. By importing the CSS file and adding the appropriate class to an element, you can style text according to Material Design guidelines.
import '@material/typography/dist/mdc.typography.css';
const myElement = document.createElement('div');
myElement.className = 'mdc-typography--headline1';
myElement.textContent = 'Hello, World!';
document.body.appendChild(myElement);Customizing Typography
This feature allows you to customize typography styles programmatically. By using the `typography` function, you can define custom styles and apply them to elements.
import { typography } from '@material/typography';
const customTypography = typography({
fontFamily: 'Roboto, sans-serif',
fontSize: '16px',
fontWeight: '400',
lineHeight: '1.5'
});
const myElement = document.createElement('div');
myElement.style.cssText = customTypography;
myElement.textContent = 'Custom Typography';
document.body.appendChild(myElement);The 'typography' package is a powerful toolkit for building beautiful websites with consistent typography. It provides a wide range of customization options and integrates well with various CSS-in-JS libraries. Compared to @material/typography, it offers more flexibility and customization options but does not strictly follow Material Design guidelines.
The 'styled-components' package allows you to write actual CSS code to style your components. It supports theming and dynamic styling, making it a versatile choice for managing typography in React applications. While it is not specifically focused on typography, it provides the tools to create and manage text styles effectively. It offers more flexibility than @material/typography but requires more setup for consistent typography.
The 'emotion' package is a library designed for writing CSS styles with JavaScript. It offers powerful and flexible styling capabilities, including support for theming and dynamic styles. Like styled-components, it is not focused solely on typography but provides the tools to manage text styles effectively. It offers more flexibility and customization compared to @material/typography but requires more effort to adhere to Material Design guidelines.
Material Design's text sizes and styles were developed to balance content density and reading comfort under typical usage conditions.
MDC Typography is a foundational module that applies these styles to MDC Web components. The typographic styles in this module are derived from thirteen styles:
npm install @material/typography
We recommend using Roboto from Google Fonts:
<head>
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500" rel="stylesheet">
</head>
<body class="mdc-typography">
<h1 class="mdc-typography--headline1">Big header</h1>
</body>
@use "@material/typography/mdc-typography";
The typography styles (referred to as <STYLE> below) used in the type system:
| Scale | Description |
|---|---|
headline1 | The largest text on the screen, reserved for short, important text or numerals |
headline2 | Headline variant 2 |
headline3 | Headline variant 3 |
headline4 | Headline variant 4 |
headline5 | Headline variant 5 |
headline6 | Headline variant 6 |
subtitle1 | Smaller than headline, reserved for medium-emphasis text that is shorter in length |
subtitle2 | Subtitle variant 2 |
body1 | Used for long-form writing |
body2 | Body variant 2 |
caption | Used sparingly to annotate imagery |
button | A call to action used by different types of buttons |
overline | Used sparingly to introduce a headline |
Some components have a set typographic style. For example, a raised MDC Card uses Body 1, Body 2, and Headline styles.
If you want to set the typographic style of an element, which is not a Material Design component, you can apply the following CSS classes.
| CSS Class | Description |
|---|---|
mdc-typography | Sets the font to Roboto |
mdc-typography--<STYLE> | Sets font properties as STYLE. Please see Typography styles section |
For example, the headline1 style as a CSS class would be mdc-typography--headline1.
| CSS Custom property | Description |
|---|---|
--mdc-typography-font-family | The base font-family |
--mdc-typography-<STYLE>-font-family | The font-family for STYLE. Please see Typography styles section |
--mdc-typography-<STYLE>-font-size | The font-size for STYLE. Please see Typography styles section |
--mdc-typography-<STYLE>-line-height | The line-height for STYLE. Please see Typography styles section |
--mdc-typography-<STYLE>-font-weight | The font-weight for STYLE. Please see Typography styles section |
--mdc-typography-<STYLE>-letter-spacing | The letter-spacing for STYLE. Please see Typography styles section |
--mdc-typography-<STYLE>-text-decoration | The text-decoration for STYLE. Please see Typography styles section |
--mdc-typography-<STYLE>-text-transform | The text-transform for STYLE. Please see Typography styles section |
| Mixin | Description |
|---|---|
base | Sets the font to Roboto |
mdc-typography($style) | Applies one of the typography styles, including setting the font to Roboto |
smooth-font | Adds antialiasing for typography |
overflow-ellipsis | Truncates overflow text to one line with an ellipsis |
baseline-top($distance) | Sets the baseline height of a text element from top. |
baseline-bottom($distance) | Sets the distance from text baseline to bottom. This mixin should be combined with baseline-top when setting baseline distance to following text element. |
A note about
overflow-ellipsis,overflow-ellipsisshould only be used if the element isdisplay: blockordisplay: inline-block.
$style ValuesThese styles can be used as the $style argument for the mdc-typography mixin.
headline1headline2headline3headline4headline5headline6subtitle1subtitle2body1body2captionbuttonoverlineAll styles can be overridden using CSS custom properties or Sass module/global variables.
When using Sass module variables, the module must be configured before any other @use
statements with a variable named $styles-{style}. The variable should be assigned to a map
that contains all the properties you want to override for a particular style.
When using Sass global variables, they must be defined before the component is imported by setting a global
variable named $mdc-typography-styles-{style}.
Example: Overriding the button font-size and text-transform properties.
CSS custom properties:
html {
--mdc-typography-button-font-size: 16px;
--mdc-typography-button-text-transform: 16px;
}
Sass module variables:
@use "@material/typography" with (
$styles-button: (
font-size: 16px,
text-transform: none,
)
);
@use "@material/button";
@include button.core-styles;
Sass global variables:
$mdc-typography-styles-button: (
font-size: 16px,
text-transform: none,
);
@import "@material/button/mdc-button";
Example: Overriding the global font-family property.
CSS custom properties:
html {
--mdc-typography-font-family: Arial, Helvetica, sans-serif;
}
Sass module variables:
@use "@material/typography" with (
$font-family: unquote("Arial, Helvetica, sans-serif")
);
@use "@material/button";
@include button.core-styles;
Sass global variables:
$mdc-typography-font-family: unquote("Arial, Helvetica, sans-serif");
@import "@material/button/mdc-button";
Example: Overriding the font-family property for headline1 and font-family and font-size for headline2.
CSS custom properties:
html {
--mdc-typography-headline1-font-family: Arial, Helvetica, sans-serif;
--mdc-typography-headline2-font-family: Arial, Helvetica, sans-serif;
--mdc-typography-headline2-font-size: 3.25rem;
}
Sass module variables:
@use "@material/typography" with (
$styles-headline1: (
$font-family: unquote("Arial, Helvetica, sans-serif")
),
$styles-headline2: (
$font-family: unquote("Arial, Helvetica, sans-serif"),
$font-size: 3.25rem
)
);
@use ...
Sass global variables:
$mdc-typography-styles-headline1: (
font-family: unquote("Arial, Helvetica, sans-serif")
);
$mdc-typography-styles-headline2: (
font-family: unquote("Arial, Helvetica, sans-serif"),
font-size: 3.25rem
);
@import ...
6.0.0 (2020-04-22)
[@use](https://github.com/use) (098ae32)indeterminate checkbox (b273afa)select: HTML Markup significantly changed, see README; REMOVED adapter methods isSelectedTextFocused, getSelectedTextAttr, setSelectedTextAttr; ADDED adapter methods isSelectAnchorFocused, getSelectAnchorAttr, setSelectAnchorAttr; removed variables outlined-dense-label-position-y, icon-padding; added variables minimum-height-for-filled-label, filled-baseline-top, selected-text-height, anchor-padding-left, anchor-padding-left-with-leading-icon, anchor-padding-right.
text-field: Redundant mixins mdc-text-field-textarea-fill-color, mdc-text-field-textarea-stroke-color, mdc-text-field-fullwidth-bottom-line-color removed. Instead, use mdc-text-field-fill-color, mdc-text-field-outline-color, and mdc-text-field-bottom-line-color respectively to achieve the same effect.
textfield: mdc-text-field--dense and associated mixins/variables have been removed. Use the density() mixin instead.
textfield: removed the following variables: $input-padding, $input-padding-top, $input-padding-bottom, $outlined-input-padding-top, $outlined-input-padding-bottom, $input-border-bottom
linear-progress: DOM for linear progress buffer changed. MDCLinearProgressAdapter method getBuffer, getPrimaryBar, setStyle removed. MDCLinearProgressAdapter method setBufferBarStyle, setPrimaryBarStyle added.
linear-progress: DOM for linear progress buffer changed. MDCLinearProgressAdapter method getBuffer, getPrimaryBar, setStyle removed. MDCLinearProgressAdapter method setBufferBarStyle, setPrimaryBarStyle added.
typography: typography.baseline-top() and typography.baseline-bottom() are now private. Use typography.baseline() for containers and typography.text-baseline() for text with $top and $bottom params.
chips: The touch target and text now appear inside the primary action element. Please see the readme for markup changes.
textfield: filled text fields must include a <div class="mdc-text-field__ripple"></div>
textfield: Filled textfields will no longer show a floating label at certain densities. This can be overridden by setting $mdc-text-field-minimum-height-for-filled-label: 40px
chips: Both MDCChipAdapter and MDCChipSetAdapter have new methods. MDCChipSetFoundation event handlers now accept the corresponding chip event detail interface as the sole argument. The root property has been removed from the MDCChipRemovalEventDetail interface.
line-ripple: mdc-line-ripple-color() mixin has been renamed to mdc-line-ripple-active-color()
textfield: Default textfields must now specify mdc-text-field--filled. Disabled outlined textfields no longer have a shaded background. Height mixin no longer specifies a baseline override, use typography's baseline-top mixin.
Four variables and a mixin in mdc-textfield were renamed to use a mdc-text-field- prefix when depended on via @import (formerly mdc-required-text-field-label-asterisk_, now required-label-asterisk_).
textfield: icons must use .mdc-text-field__icon--leading or .mdc-text-field__icon--trailing classes. mdc-text-field-icon-color() mixin has been split into mdc-text-field-leading-icon-color() and mdc-text-field-trailing-icon-color().
switch: Added setNativeControlAttr method in mdc-switch adapter.
checkbox: remove event listener for 'change' and add event listener for 'click'.
$mdc-button-disabled-container-fill-color
renamed to $mdc-button-disabled-container-color.$edgeOptOut option from mdc-theme-prop() Sass mixin.FAQs
Typography classes, mixins, and variables for Material Components for the web
The npm package @material/typography receives a total of 754,435 weekly downloads. As such, @material/typography popularity was classified as popular.
We found that @material/typography demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 15 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.