Skip to main content

Overview

Theming is the most important aspect of any template. You can easily customize theme of our template. You can change the colors, the typography, the spacing and much more.

MUI offers a utility function: createTheme that creates a theme which can be passed to the theme provider, otherwise the theme provider uses the default theme. The theme provider makes the theme available in the component tree, and can be used via the sx prop, or inside styled components using the MUI styled engine (styled). You can read more about MUI createTheme in the official docs.

We are using ThemeProvider which is built on top of CustomThemeProvider and provides a way to use CSS variables in your theme. It is useful when you want to use CSS variables in your theme. Consider reading MUI ThemeProvider docs for more information.

Important

To customize colors, typography, spacing, or other aspects of component styling, please modify the src/components/theme/mergedTheme.ts file. Avoid altering theme settings within the @core folder, unless directed by our support team.

Important

If you want to use your own custom theme from scratch, you can follow the steps mentioned in How to create your own custom theme.

Common Customization steps​

Note

Following two steps are common for all the customizations in the theme.

  1. Open the src/components/theme/index.tsx file and add and remove the imports and shown below:

    - import defaultCoreTheme from '@core/theme'
    + import mergedTheme from './mergedTheme'

  2. Now use mergedTheme instead of defaultCoreTheme in the CustomThemeProvider component as shown below:

    src/components/theme/index.tsx
    - const coreTheme = deepmerge(defaultCoreTheme(..), ...)
    + const coreTheme = deepmerge(mergedTheme(..), ...)