Theming

Customize Material-UI with your theme. You can change the colors, the typography and much more.

The theme specifies the color of the components, darkness of the surfaces, level of shadow, appropriate opacity of ink elements, etc.

Themes let you apply a consistent tone to your app. It allows you to customize all design aspects of your project in order to meet the specific needs of your business or brand.

To promote greater consistency between apps, light and dark theme types are available to choose from. By default, components use the light theme type.

Theme provider

If you wish to customize the theme, you need to use the ThemeProvider component in order to inject a theme into your application. However, this is optional; Material-UI components come with a default theme.

ThemeProvider relies on the context feature of React to pass the theme down to the components, so you need to make sure that ThemeProvider is a parent of the components you are trying to customize. You can learn more about this in the API section.

Theme configuration variables

Changing the theme configuration variables is the most effective way to match Material-UI to your needs. The following sections cover the most important theme variables:

You can check out the default theme section to view the default theme in full.

Custom variables

When using Material-UI's theme with the styling solution or any others, it can be convenient to add additional variables to the theme so you can use them everywhere. For instance:

const theme = createTheme({
  status: {
    danger: orange[500],
  },
});

If you are using TypeScript, you would also need to use module augmentation for the theme to accept the above values.

declare module '@material-ui/core/styles' {
  interface Theme {
    status: {
      danger: string;
    };
  }
  // allow configuration using `createTheme`
  interface ThemeOptions {
    status?: {
      danger?: string;
    };
  }
}

<ThemeProvider theme={theme}>
  <CustomCheckbox defaultChecked />
</ThemeProvider>

Theme builder

The community has built great tools to build a theme:

mui-theme-creator: A tool to help design and customize themes for the Material-UI component library. Includes basic site templates to show various components and how they are affected by the theme
create-mui-theme: Is an online tool for creating Material-UI themes via Material Design Color Tool.
Material palette generator: The Material palette generator can be used to generate a palette for any color you input.

Accessing the theme in a component

You can access the theme variables inside your React components.

Nesting the theme

You can nest multiple theme providers.

<ThemeProvider theme={outerTheme}>
  <Checkbox defaultChecked />
  <ThemeProvider theme={innerTheme}>
    <Checkbox defaultChecked />
  </ThemeProvider>
</ThemeProvider>

The inner theme will override the outer theme. You can extend the outer theme by providing a function:

A note on performance

The performance implications of nesting the ThemeProvider component are linked to JSS's work behind the scenes. The main point to understand is that the injected CSS is cached with the following tuple (styles, theme).

theme: If you provide a new theme at each render, a new CSS object will be computed and injected. Both for UI consistency and performance, it's better to render a limited number of theme objects.
styles: The larger the styles object is, the more work is needed.

API

`createTheme(options, ...args) => theme`

Generate a theme base on the options received.

Arguments

options (object): Takes an incomplete theme object and adds the missing parts.
...args (object[]): Deep merge the arguments with the about to be returned theme.

Returns

theme (object): A complete, ready-to-use theme object.

Examples

import { createTheme } from '@material-ui/core/styles';
import purple from '@material-ui/core/colors/purple';
import green from '@material-ui/core/colors/green';

const theme = createTheme({
  palette: {
    primary: {
      main: purple[500],
    },
    secondary: {
      main: green[500],
    },
  },
});

`responsiveFontSizes(theme, options) => theme`

Generate responsive typography settings based on the options received.

Arguments

theme (object): The theme object to enhance.
options (object [optional]):

breakpoints (array<string> [optional]): Default to ['sm', 'md', 'lg']. Array of breakpoints (identifiers).
disableAlign (bool [optional]): Default to false. Whether font sizes change slightly so line heights are preserved and align to Material Design's 4px line height grid. This requires a unitless line height in the theme's styles.
factor (number [optional]): Default to 2. This value determines the strength of font size resizing. The higher the value, the less difference there is between font sizes on small screens. The lower the value, the bigger font sizes for small screens. The value must be greater than 1.
variants (array<string> [optional]): Default to all. The typography variants to handle.

Returns

theme (object): The new theme with a responsive typography.

Examples

import { createTheme, responsiveFontSizes } from '@material-ui/core/styles';

let theme = createTheme();
theme = responsiveFontSizes(theme);

`unstable_createMuiStrictModeTheme(options, ...args) => theme`

WARNING: Do not use this method in production.

Generates a theme that reduces the amount of warnings inside React.StrictMode like Warning: findDOMNode is deprecated in StrictMode.

Requirements

Currently unstable_createMuiStrictModeTheme adds no additional requirements.

Arguments

options (object): Takes an incomplete theme object and adds the missing parts.
...args (object[]): Deep merge the arguments with the about to be returned theme.

Returns

theme (object): A complete, ready to use theme object.

Examples

import { unstable_createMuiStrictModeTheme } from '@material-ui/core/styles';

const theme = unstable_createMuiStrictModeTheme();

function App() {
  return (
    <React.StrictMode>
      <ThemeProvider theme={theme}>
        <LandingPage />
      </ThemeProvider>
    </React.StrictMode>
  );
}