Skip to main content
Version: 4.xx.xx

Theming

The theme object is where you define your application's color palette, type scale, font stacks, breakpoints, border radius values, and more. You can either create your own theme object or use theme that provide from Refine. You can find more information about theme in Chakra UI documentation.

For more information, refer to the Chakra UI documentation β†’

Predefined Themes​

RefineThemes has predefined themes for you. You can use them by importing them from the @refinedev/chakra-ui package. It is not required if you decide to use the default Chakra UI theme.

const { Blue, Purple, Magenta, Red, Orange, Yellow } = RefineThemes;
import { Refine } from "@refinedev/core";
import { ThemedLayoutV2, RefineThemes } from "@refinedev/chakra-ui";

import { ChakraProvider } from "@chakra-ui/react";

const App: React.FC = () => {
return (
<ChakraProvider theme={RefineThemes.Blue}>
<Refine
/* ... */
>
<ThemedLayoutV2>{/* ... */}</ThemedLayoutV2>
</Refine>
</ChakraProvider>
);
};

You can see how themes change the look of the application in this example β†’

If you want to use <ThemedLayoutV2> you have to wrap your application with the <ChakraProvider> component and should give theme prop to it.

You can use RefineThemes provided by Refine or you can create your own theme object.

For more information, please refer to the Chakra UI documentation β†’

Theme customization​

<ChakraProvider/> component can be used to change the theme and other global settings. It is not required if you decide to use the default theme. You can also use RefineThemes provided by Refine.

localhost:3000
import { Refine } from "@refinedev/core";
import routerProvider from "@refinedev/react-router-v6";
import dataProvider from "@refinedev/simple-rest";
import {
ErrorComponent,
ThemedLayoutV2,
useNotificationProvider,
RefineThemes,
} from "@refinedev/chakra-ui";
import {
ChakraProvider,
extendTheme,
} from "@chakra-ui/react";

import { BrowserRouter, Routes, Route, Outlet } from "react-router-dom";

import { PostCreate, PostEdit, PostList } from "./pages";

const App = () => {
const customTheme = extendTheme({
...RefineThemes.Blue,
colors: {
sider: {
background: "#4A5568",
collapseButton: "#1a202c",
},
},
});

return (
<ChakraProvider theme={customTheme}>
<BrowserRouter>
<Refine
routerProvider={routerProvider}
dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
notificationProvider={notificationProvider()}
resources={[
{
name: "posts",
list: "/posts",
edit: "/posts/edit/:id",
create: "/posts/create",
},
]}
>
<Routes>
<Route
element={
<ThemedLayoutV2>
<Outlet />
</ThemedLayoutV2>
}
>
<Route path="posts">
<Route index element={<PostList />} />
<Route path="create" element={<PostCreate />} />
<Route path="edit/:id" element={<PostEdit />} />
</Route>
<Route path="*" element={<ErrorComponent />} />
</Route>
</Routes>
</Refine>
</BrowserRouter>
</ChakraProvider>
);
};

Refer to the refineTheme object in the source code to see the default theme values β†’

Theme switching​

Chakra UI comes with built-in support for managing color mode in your apps. You can manage the color mode on Refine applications such as Chakra UI applications.

Chakra stores the color mode in localStorage and appends a className to the body to ensure the color mode is persistent.

For more information, refer to the Chakra UI documentation β†’

localhost:3000
import { Refine } from "@refinedev/core";
import routerProvider from "@refinedev/react-router-v6";
import dataProvider from "@refinedev/simple-rest";
import {
ErrorComponent,
ThemedLayoutV2,
useNotificationProvider,
RefineThemes,
} from "@refinedev/chakra-ui";
import {
ChakraProvider,
Box,
IconButton,
Icon,
useColorMode,
extendTheme,
} from "@chakra-ui/react";
import { IconSun, IconMoonStars } from "@tabler/icons-react";

import { BrowserRouter, Routes, Route, Outlet } from "react-router-dom";

import { PostCreate, PostEdit, PostList } from "./pages";

const Header = () => {
const { colorMode, toggleColorMode } = useColorMode();
return (
<Box
py="2"
px="4"
display="flex"
justifyContent="flex-end"
w="full"
bg="chakra-body-bg"
>
<IconButton
variant="ghost"
aria-label="Toggle theme"
onClick={toggleColorMode}
>
<Icon
as={colorMode === "light" ? IconMoonStars : IconSun}
w="18px"
h="18px"
/>
</IconButton>
</Box>
);
};

const App = () => {
const customTheme = extendTheme({
...RefineThemes.Blue,
config: {
initialColorMode: "dark",
useSystemColorMode: false,
},
});

return (
<ChakraProvider theme={customTheme}>
<BrowserRouter>
<Refine
routerProvider={routerProvider}
dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
notificationProvider={notificationProvider()}
resources={[
{
name: "posts",
list: "/posts",
edit: "/posts/edit/:id",
create: "/posts/create",
},
]}
>
<Routes>
<Route
element={
<ThemedLayoutV2 Header={Header}>
<Outlet />
</ThemedLayoutV2>
}
>
<Route path="posts">
<Route index element={<PostList />} />
<Route path="create" element={<PostCreate />} />
<Route path="edit/:id" element={<PostEdit />} />
</Route>
<Route path="*" element={<ErrorComponent />} />
</Route>
</Routes>
</Refine>
</BrowserRouter>
</ChakraProvider>
);
};

If you want to customize the default layout elements provided with @refinedev/chakra-ui package, check out the Custom Layout tutorial.