Customize Theme
Change the look and feel of your web app as per your design
In Jumbo, The theme is divided in four main sections as given below:
Main Theme
Header Theme
Sidebar Theme
Footer Theme
Using these four themes, the theme for the whole application can easily be setup as per the requirement.
These four themes are managed in the /src/themes folder. Here, in this folder, you can see there are four separate folders to organize the theme object for individual four sections as mentioned above.
This theme object is an extension to the MUI's theme object. So, you can follow all the theme related documentation available at mui.com to customize and extending the theme.
Setting up a New Theme
To setup a new theme (let's say themex), you need to create following four files:
/src/themes/main/themex.ts
/src/themes/header/themex.ts
/src/themes/sidebar/themex.ts
/src/themes/footer/themex.ts
In each file above, you can export a theme variable as in the below sample code snippet
import { Shadows, ThemeOptions } from '@mui/material';
const shadows: Shadows = [
'none',
'0px 2px 1px -1px rgba(0,0,0,0.2),0px 1px 1px 0px rgba(0,0,0,0.14),0px 1px 3px 0px rgba(0,0,0,0.12)',
'0px 3px 1px -2px rgba(0,0,0,0.2),0px 2px 2px 0px rgba(0,0,0,0.14),0px 1px 5px 0px rgba(0,0,0,0.12)',
'0px 3px 3px -2px rgba(0,0,0,0.2),0px 3px 4px 0px rgba(0,0,0,0.14),0px 1px 8px 0px rgba(0,0,0,0.12)',
'0px 2px 4px -1px rgba(0,0,0,0.2),0px 4px 5px 0px rgba(0,0,0,0.14),0px 1px 10px 0px rgba(0,0,0,0.12)',
'0px 3px 5px -1px rgba(0,0,0,0.2),0px 5px 8px 0px rgba(0,0,0,0.14),0px 1px 14px 0px rgba(0,0,0,0.12)',
'0px 3px 5px -1px rgba(0,0,0,0.2),0px 6px 10px 0px rgba(0,0,0,0.14),0px 1px 18px 0px rgba(0,0,0,0.12)',
'0px 4px 5px -2px rgba(0,0,0,0.2),0px 7px 10px 1px rgba(0,0,0,0.14),0px 2px 16px 1px rgba(0,0,0,0.12)',
'0px 5px 5px -3px rgba(0,0,0,0.2),0px 8px 10px 1px rgba(0,0,0,0.14),0px 3px 14px 2px rgba(0,0,0,0.12)',
'0px 5px 6px -3px rgba(0,0,0,0.2),0px 9px 12px 1px rgba(0,0,0,0.14),0px 3px 16px 2px rgba(0,0,0,0.12)',
'0px 6px 6px -3px rgba(0,0,0,0.2),0px 10px 14px 1px rgba(0,0,0,0.14),0px 4px 18px 3px rgba(0,0,0,0.12)',
'0px 6px 7px -4px rgba(0,0,0,0.2),0px 11px 15px 1px rgba(0,0,0,0.14),0px 4px 20px 3px rgba(0,0,0,0.12)',
'0px 7px 8px -4px rgba(0,0,0,0.2),0px 12px 17px 2px rgba(0,0,0,0.14),0px 5px 22px 4px rgba(0,0,0,0.12)',
'0px 7px 8px -4px rgba(0,0,0,0.2),0px 13px 19px 2px rgba(0,0,0,0.14),0px 5px 24px 4px rgba(0,0,0,0.12)',
'0px 7px 9px -4px rgba(0,0,0,0.2),0px 14px 21px 2px rgba(0,0,0,0.14),0px 5px 26px 4px rgba(0,0,0,0.12)',
'0px 8px 9px -5px rgba(0,0,0,0.2),0px 15px 22px 2px rgba(0,0,0,0.14),0px 6px 28px 5px rgba(0,0,0,0.12)',
'0px 8px 10px -5px rgba(0,0,0,0.2),0px 16px 24px 2px rgba(0,0,0,0.14),0px 6px 30px 5px rgba(0,0,0,0.12)',
'0px 8px 11px -5px rgba(0,0,0,0.2),0px 17px 26px 2px rgba(0,0,0,0.14),0px 6px 32px 5px rgba(0,0,0,0.12)',
'0px 9px 11px -5px rgba(0,0,0,0.2),0px 18px 28px 2px rgba(0,0,0,0.14),0px 7px 34px 6px rgba(0,0,0,0.12)',
'0px 9px 12px -6px rgba(0,0,0,0.2),0px 19px 29px 2px rgba(0,0,0,0.14),0px 7px 36px 6px rgba(0,0,0,0.12)',
'0px 10px 13px -6px rgba(0,0,0,0.2),0px 20px 31px 3px rgba(0,0,0,0.14),0px 8px 38px 7px rgba(0,0,0,0.12)',
'0px 10px 13px -6px rgba(0,0,0,0.2),0px 21px 33px 3px rgba(0,0,0,0.14),0px 8px 40px 7px rgba(0,0,0,0.12)',
'0px 10px 14px -6px rgba(0,0,0,0.2),0px 22px 35px 3px rgba(0,0,0,0.14),0px 8px 42px 7px rgba(0,0,0,0.12)',
'0 5px 10px rgba(0, 0, 0, 0.085)',
'0 5px 10px rgba(0, 0, 0, 0.175)',
];
export const mainTheme: ThemeOptions = {
type: 'light',
breakpoints: {
values: {
xs: 0,
sm: 576,
md: 768,
lg: 992,
xl: 1200,
},
},
palette: {
primary: {
main: '#7352C7',
light: '#A67FFB',
dark: '#5E3BB7',
contrastText: '#FFF',
},
secondary: {
main: '#E44A77',
light: '#FF7EA6',
dark: '#DF295E',
contrastText: '#FFF',
},
error: {
main: '#E73145',
light: '#FF6A70',
dark: '#AD001E',
contrastText: '#FFF',
},
warning: {
main: '#F39711',
light: '#FFC84C',
dark: '#BB6900',
contrastText: '#FFF',
},
info: {
main: '#2EB5C9',
light: '#6FE7FC',
dark: '#008598',
contrastText: '#FFF',
},
success: {
main: '#3BD2A2',
light: '#78FFD3',
dark: '#00A073',
contrastText: '#FFF',
},
text: {
primary: '#475259',
secondary: '#8595A6',
disabled: '#A2B2C3',
},
divider: '#DEE2E6',
background: {
paper: '#FFFFFF',
default: '#F5F7FA',
},
action: {
active: '#475259',
hover: '#F5F7FA',
},
},
shadows: shadows,
typography: {
fontFamily: 'NoirPro, Arial',
fontSize: 14,
h1: {
fontSize: '1.5rem',
lineHeight: 1.2,
fontWeight: 400,
color: '#37373C',
margin: '0 0 .5rem',
},
h2: {
fontSize: '1.4rem',
lineHeight: 1.2,
fontWeight: 400,
color: '#37373C',
margin: '0 0 .5rem',
},
h3: {
fontSize: '1.25rem',
lineHeight: 1.2,
fontWeight: 400,
color: '#37373C',
margin: '0 0 .5rem',
},
h4: {
fontSize: '1.1rem',
lineHeight: 1.2,
fontWeight: 400,
color: '#37373C',
margin: '0 0 .5rem',
},
h5: {
fontSize: '1rem',
lineHeight: 1.2,
fontWeight: 400,
color: '#37373C',
margin: '0 0 .5rem',
},
h6: {
fontSize: '.875rem',
lineHeight: 1.2,
fontWeight: 400,
color: '#37373C',
margin: '0 0 .5rem',
},
body1: {
fontSize: '.875rem',
},
},
jumboComponents: {
JumboNavbar: {
nav: {
action: {
active: '#7352C7',
hover: '#7352C7',
},
background: {
active: 'rgba(115, 82, 199, 0.15)',
hover: '#E9ECEF',
},
tick: {
active: '#7352C7',
hover: '#ADB5BD',
},
},
},
},
components: {
MuiTableCell: {
styleOverrides: {
root: {
borderColor: `rgb(0, 0, 0, 0.1)`,
},
head: {
textTransform: 'uppercase',
letterSpacing: 1.5,
fontWeight: 400,
fontSize: 12,
lineHeight: 1.25,
background: '#F6F6F6',
},
},
},
MuiMenuItem: {
styleOverrides: {
root: {
minHeight: 'auto',
},
},
},
MuiCard: {
styleOverrides: {
root: {
borderRadius: 12,
boxShadow: `0 0.5rem 1.25rem rgba(115, 82, 199, 0.175)`,
},
},
},
MuiCardContent: {
styleOverrides: {
root: {
padding: 24,
},
},
},
MuiAccordion: {
styleOverrides: {
root: {
boxShadow: `0 0.5rem 1.25rem rgba(115, 82, 199, 0.175)`,
':first-of-type': {
borderTopLeftRadius: 12,
borderTopRightRadius: 12,
},
':last-of-type': {
borderBottomLeftRadius: 12,
borderBottomRightRadius: 12,
},
},
},
},
MuiAccordionDetails: {
styleOverrides: {
root: {
padding: '0 20px 20px',
},
},
},
MuiAccordionSummary: {
styleOverrides: {
root: {
paddingInline: 20,
},
content: {
marginBlock: 20,
},
},
},
MuiCardHeader: {
styleOverrides: {
root: {
padding: '18px 24px',
},
title: {
fontSize: '1.1rem',
marginBottom: 0,
},
subheader: {
margin: '4px 0 0',
},
action: {
margin: 0,
},
},
},
MuiCardActions: {
styleOverrides: {
root: {
padding: '8px 24px',
},
},
},
MuiChip: {
styleOverrides: {
sizeSmall: {
height: 22,
fontSize: 12,
},
labelMedium: {
paddingInline: 16,
},
},
},
MuiButton: {
styleOverrides: {
root: {
fontWeight: 400,
letterSpacing: 1,
},
sizeSmall: {
fontSize: '12px',
},
},
},
MuiPopover: {
styleOverrides: {
paper: {
borderRadius: 8,
},
},
},
MuiDialogTitle: {
styleOverrides: {
root: {
fontSize: 18,
},
},
},
MuiDialogActions: {
styleOverrides: {
root: {
padding: '16px 24px',
},
},
},
MuiAvatarGroup: {
styleOverrides: {
avatar: {
fontSize: 16,
},
},
},
},
};
In the Header, Footer and Sidebar Themes, as mentioned previously, you can only specify those properties (theme variables) which need be overridden. Rest of the properties will be inherited from Main Theme.
Setting Up the Default Theme
To set a theme as default theme, you can make the changes in /src/config/index.ts file. In this file, you can set the THEME property of the CONFIG variable as mentioned below:
import { footerTheme } from '@/themes/footer/default';
import { headerTheme } from '@/themes/header/default';
import { mainTheme } from '@/themes/main/default';
import { sidebarTheme } from '@/themes/sidebar/default';
import { JumboThemeConfig } from '@jumbo/types';
import { createJumboTheme } from '@jumbo/utilities/helpers';
import { anonymousPaths, publicPaths } from './routes/path';
type ConfigType = {
THEME: JumboThemeConfig;
PUBLIC_ROUTES: string[];
ANONYMOUS_ROUTES: string[];
DISABLE_PROTECTED_ROUTE_CHECK: boolean;
};
export const CONFIG: ConfigType = {
THEME: createJumboTheme(mainTheme, headerTheme, sidebarTheme, footerTheme),
PUBLIC_ROUTES: publicPaths,
ANONYMOUS_ROUTES: anonymousPaths,
DISABLE_PROTECTED_ROUTE_CHECK: false,
};
Understanding how this CONFIG.THEME variable is being used
In the root layout (/src/app/layout.tsx), you can see that the CONFIG.THEME property we have set above is being passed in the init prop of the JumboTheme as follows:
<JumboTheme init={CONFIG.THEME}>
<CssBaseline />
<JumboDialogProvider>
<JumboDialog />
<AppSnackbar>{children}</AppSnackbar>
</JumboDialogProvider>
</JumboTheme>
This is all you need to do to setup a default theme for your web app.
Dynamically Changing Theme
Jumbo usages Context API to manage the active theme state of the web app. You can leverage the custom hooks offered by Jumbo to make the theme changes dynamically.
Following are some of the custom hooks you can utilise:
useJumboTheme
import { useJumboTheme } from '@jumbo/components/JumboTheme/hooks';
const { theme, setTheme, muiLocale, setMuiLocale } = useJumboTheme();useJumboHeaderTheme
import { useJumboHeaderTheme } from '@jumbo/components/JumboTheme/hooks';
const { headerTheme, setHeaderTheme } = useJumboHeaderTheme();useJumboSidebarTheme
import { useJumboSidebarTheme } from '@jumbo/components/JumboTheme/hooks';
const { sidebarTheme, setSidebarTheme } = useJumboSidebarTheme();useJumboFooterTheme
import { useJumboFooterTheme } from '@jumbo/components/JumboTheme/hooks';
const { footerTheme, setFooterTheme } = useJumboFooterTheme();Last updated