Theming
A theme in material is a set of CSS custom properties: one per Material 3 colour role, named
--mtrl-sys-color-<role>. primary, on-primary, primary-container, the surfaces, the
outlines and the rest are the roles M3 defines, and the components take their colours from
them. Changing a theme changes those properties and nothing else, so it needs no
JavaScript and no rebuild, and it reaches the web components too, since custom properties
inherit into shadow roots.
The baseline declares M3's 45 roles, light and dark, and each theme sets them for its own palette. Styles › Color shows them all, in every shipped theme.
The baseline
The base stylesheet, which every app imports once, holds M3's baseline theme (primary
#6750A4) on :root, with the shape and state tokens. The type scale is
material/styles/typography:
import 'material/styles/base';
import 'material/styles/typography';
With nothing else, the whole page uses the baseline, light or dark as the system prefers.
The base holds only the three body-medium tokens the page's text reads
(--mtrl-sys-typescale-body-medium-font, -font-size and -line-height). Import the
typography stylesheet when the page uses the type classes or the text utilities, relies on
the heading and paragraph styles, or reads a --mtrl-sys-typescale-* token in its own CSS.
Without it a .mtrl-headline-small element keeps the body's font size, and a
var(--mtrl-sys-typescale-*) with no fallback is invalid at computed-value time.
The typography stylesheet has to load after the base: both style h1 to h6 and p, and the
later one wins. The import takes care of it, because the module imports the base first. If
your bundler splits the two into different chunks, make sure the base's CSS loads first: an
import order is not a CSS order in every bundler. With <link> tags, put
dist/styles/typography.css after dist/styles/base.css.
Another theme
A theme is one more import, and it applies wherever an element names it with data-theme.
data-theme-mode="dark" on the same element switches it to its dark roles:
import 'material/themes/ocean';
document.documentElement.dataset.theme = 'ocean';
document.documentElement.dataset.themeMode = 'dark';
The attributes work on any element, not only <html>. The roles are custom properties, so
everything inside the element takes the theme and the rest of the page keeps its own. A preview
panel, a sidebar or a dark header can each have a theme:
<header data-theme="ocean" data-theme-mode="dark">
<m-button variant="filled">Sign in</m-button>
</header>
<main>…</main>
data-theme-mode belongs on the element that has data-theme: the dark roles are declared for
the two together. The theme files are not in a cascade layer while the base styles are, so a
theme wins over the baseline whatever order the stylesheets load in.
Dark mode
The baseline follows the system: material/styles/base sets its dark roles on :root under
@media (prefers-color-scheme: dark). A named theme doesn't. Once data-theme is set, its
light roles apply until data-theme-mode="dark" asks for the dark ones, and that includes
data-theme="baseline", which is how an app offers a light setting on a dark system. To follow
the system with another theme, keep the attribute in step with the media query:
const dark = matchMedia('(prefers-color-scheme: dark)');
const root = document.documentElement;
const follow = () => { root.dataset.themeMode = dark.matches ? 'dark' : 'light'; };
follow();
dark.addEventListener('change', follow);
Removing data-theme returns the page to the baseline and to the system's mode.
The shipped themes
Each theme is its own entry, material/themes/<name>, so an app only loads the one it uses.
- M3's scheme variants.
neutral,vibrant,expressive,fidelity,content,monochrome,rainbowandfruit-saladare M3's dynamic-scheme variants, generated with Google's colour library from the baseline seed. The baseline is the ninth, Tonal Spot. They exist only as their own entries, never in the full stylesheet. material's own themes.ocean,forest,spring,sunsetandautumnare set by hand;desert,summer,brownbeige,sageivoryandtealcaramelare generated from a seed and keep a second colour of their own as the secondary, with every text pair at 4.5:1 or more.- High contrast.
highcontrastis M3's high-contrast scheme from the baseline seed, with 7:1 or more on every text pair. The base stylesheet and each theme also follow the operating system'sprefers-contrast: more. To set contrast explicitly, withdata-theme-contrast="medium"or"high", importmaterial/styles/contrastandmaterial/themes/<name>-contrastbeside the theme.
The full stylesheet, material/styles, already contains the baseline, material's own themes and
high contrast, so with it only the scheme variants need an import. Explicit contrast is still
the separate contrast and <name>-contrast stylesheets.
Contrast
Every theme supports three contrast levels. data-theme-contrast="standard", "medium" or
"high" goes on the same element as data-theme and data-theme-mode:
<html data-theme="desert" data-theme-mode="dark" data-theme-contrast="high">
The attribute is opt-in. The full stylesheet includes it; selective styles add
material/styles/contrast for the baseline, and material/themes/<name>-contrast beside
each theme. Without that import the attribute changes no colour. The operating system's
preference needs no import.
import 'material/styles/base';
import 'material/styles/contrast';
import 'material/themes/desert';
import 'material/themes/desert-contrast';
How a level is chosen:
- Without the attribute,
prefers-contrast: moreselects high contrast, on every themed element independently. - An explicit
standardopts out on that element;mediumoverrides the preference too. - The setting does not inherit across a nested theme. Put
data-theme-contraston the same element as eachdata-theme, nested sections included. Opting out on the root does not opt out a nested theme that has nodata-theme-contrast="standard"of its own. - It is read where the theme is. That is the element that carries
data-theme, or the root when the page has nodata-theme. On any other element it does nothing: that element inherits its themed ancestor's level.
The default baseline supports the setting without data-theme. On that unthemed root, both
standard and higher contrast follow the system's colour scheme and .dark-theme, and ignore
data-theme-mode.
How the levels are derived:
- Medium and high use M3's contrast levels 0.5 and 1.0.
- Hand-authored themes derive them with Tonal Spot from their documented seed, falling back to their light primary, and keep their light secondary and tertiary hues and chroma.
- Neutral palettes come from the seed, while standard colours stay unchanged.
- Success, warning and info keep their status colours.
- The
highcontrasttheme is a theme in its own right and supports all three settings.
Import material/styles/contrast after material/styles/base, as with the typography
stylesheet: the opt-in sheets share the base cascade layer, so their order inside it matters.
The contrast colours do not depend on it. An explicit level is a more specific selector than
the standard rule, and prefers-contrast: more is guarded by :not([data-theme-contrast]),
so either load order resolves the same colours.
Your own theme
From a seed colour
M3 builds a whole scheme from one colour. Google's
material-color-utilities does
the colour science, and schemeToTokens from material/core/theme turns a light and a dark scheme
into material's custom properties. It is the function material's own themes are generated with, so a
theme you make this way declares exactly what a shipped one does. It takes the role names
kebab-case or camelCase, and throws if a role is missing or isn't a #rrggbb colour.
A function that installs a theme under a name you pick:
import { schemeToTokens, type SchemeRoles } from 'material/core/theme';
function installTheme(name: string, light: SchemeRoles, dark: SchemeRoles) {
const tokens = schemeToTokens({ light, dark });
const block = (declarations: Record<string, string>) =>
Object.entries(declarations).map(([property, value]) => `${property}: ${value};`).join(' ');
const style = document.createElement('style');
style.textContent = `[data-theme="${name}"] { ${block(tokens.light)} }
[data-theme="${name}"][data-theme-mode="dark"] { ${block(tokens.dark)} }`;
document.head.append(style);
}
The schemes come from the colour library, which is your app's dependency, not material's
(npm install @material/material-color-utilities). This block is marked as a sketch because the
docs check doesn't install that library; it type-checks against its 0.4 release:
import { argbFromHex, hexFromArgb, Hct, SchemeTonalSpot, type DynamicScheme } from '@material/material-color-utilities';
import { THEME_ROLES } from 'material/core/theme';
// A scheme's colour for each role material sets; the library names them in camelCase
const roles = (scheme: DynamicScheme) => Object.fromEntries(THEME_ROLES.map((role) => {
const getter = role.replace(/-(\w)/g, (_, letter: string) => letter.toUpperCase()) as keyof DynamicScheme;
return [role, hexFromArgb(scheme[getter] as number)];
}));
const seed = Hct.fromInt(argbFromHex('#0b57d0'));
installTheme('brand', roles(new SchemeTonalSpot(seed, false, 0)), roles(new SchemeTonalSpot(seed, true, 0)));
document.documentElement.dataset.theme = 'brand';
SchemeVibrant, SchemeExpressive and the other variants take the same arguments, and the
last one is the contrast level: 1 gives a high-contrast scheme. The same tokens can be written
to a .css file at build time instead.
By hand
A theme is only CSS, so you can write one. Roles you leave out inherit from the page, so a brand colour can change just the primary family and keep the baseline's surfaces:
[data-theme="brand"] {
--mtrl-sys-color-primary: #0b57d0;
--mtrl-sys-color-on-primary: #ffffff;
--mtrl-sys-color-primary-container: #d8e2ff;
--mtrl-sys-color-on-primary-container: #001a41;
}
[data-theme="brand"][data-theme-mode="dark"] {
--mtrl-sys-color-primary: #adc6ff;
--mtrl-sys-color-on-primary: #002e69;
--mtrl-sys-color-primary-container: #004494;
--mtrl-sys-color-on-primary-container: #d8e2ff;
}
Keep each pair's contrast at 4.5:1 or more, as the shipped themes do; picking the tones from a tonal palette, as the seed route does, gets it for free.
Colour with transparency
A tinted or translucent role is color-mix, as material's own styles do it:
.selected-row {
background: color-mix(in srgb, var(--mtrl-sys-color-primary) 12%, transparent);
}
The --mtrl-sys-color-<role>-rgb twins, written for rgba(var(…), a), were removed in 0.10.
rgba(var(--mtrl-sys-color-primary-rgb), 0.12) becomes the rule above, the alpha as a
percentage.
The other tokens
material/styles/typography, imported with the base, puts the type scale on :root. The base
keeps shape and state, and body-medium's size tokens:
- Type scale:
--mtrl-sys-typescale-<role>-font,-font-size,-line-height,-letter-spacingand-font-weightfor every role fromdisplay-largetolabel-small. The fonts come from two faces,--mtrl-ref-typeface-brand(display, headline, title) and--mtrl-ref-typeface-plain(body, label). The typescale classes (.mtrl-body-large) and the document's headings and paragraphs read them, so one face set on:rootreaches all of them. - Shape:
--mtrl-sys-shape-corner-<step>, fromnone(0) throughsmall(8px),medium(12px) andextra-large(28px) tofull. - State layers:
--mtrl-sys-state-hover-state-layer-opacity(0.08), and thefocus,pressedanddraggedopacities.
:root {
--mtrl-ref-typeface-brand: "Google Sans", "Roboto", sans-serif;
}
.promo-card {
border-radius: var(--mtrl-sys-shape-corner-extra-large);
font: var(--mtrl-sys-typescale-title-large-font-weight) var(--mtrl-sys-typescale-title-large-font-size) / var(--mtrl-sys-typescale-title-large-line-height) var(--mtrl-sys-typescale-title-large-font);
}
The components read the typefaces and the corner steps too, with M3's values as the fallback,
so a brand face or rounder corners set on :root, or on one part of the page, reach every
component there: factories and web components alike.
.compact-app {
--mtrl-ref-typeface-plain: "Inter", sans-serif;
--mtrl-sys-shape-corner-medium: 6px;
}
Sizes, weights and state-layer opacities stay M3's in the components, and a few components still draw their own corners (a dialog, a tooltip, a menu). Styles › Typography shows the whole type scale.