Version: 4.xx.xxSwizzle ReadySource Code

<ThemedLayout>

http://localhost:3000

const authProvider = {
    login: async () => ({
        success: true,
        redirectTo: "/",
    }),
    logout: async () => ({
        success: true,
        redirectTo: "/login",
    }),
    onError: async (error) => {
        console.error(error);
        return { error };
    },
    check: async () => ({
        authenticated: true,
    }),
    getIdentity: async () => ({
        id: 1,
        name: "Jane Doe",
        avatar: "https://unsplash.com/photos/IWLOvomUmWU/download?force=true&w=640",
    }),
};

<ThemedLayout> component that uses the [<Layout>][antd-layout] and [<Sider>][antd-sider] components from the Antd Design library to define the layout and structure of a web page. It includes customizable components for the header, sidebar, title, footer, and off-layout area, which can be replaced or customized as needed.

By using <ThemedLayout>, developers can create a consistent look and feel across multiple pages or sections of a website, while also improving code maintainability and reusability. The customizable sections of <ThemedLayout> include:

[<ThemedHeader>][themed-header]: displayed at the top of the page and can display the user's name and avatar.
[<ThemedSider>][themed-sider]: displayed on the left side of the page and can display menu items.
[<ThemedTitle>][themed-title]: displayed at the top of [<ThemedSider>][themed-sider] and includes an icon and text.
<Footer>: displayed at the bottom of the page.
<OffLayoutArea>: rendered outside of the main layout component and can be placed anywhere on the page while still being part of the overall layout.

Footer and OffLayoutArea do not have any default components.

Usage

We'll show what default <ThemedLayout> looks like in the following example.

http://localhost:3000

import { Refine } from "@refinedev/core";
import { ThemedLayout, RefineThemes } from "@refinedev/antd";
import { ConfigProvider } from "antd";
import { AntdInferencer } from "@refinedev/inferencer/antd";

import routerProvider from "@refinedev/react-router-v6";
import { BrowserRouter, Routes, Route, Outlet } from "react-router-dom";

import dataProvider from "@refinedev/simple-rest";

import { authProvider } from "./authProvider";

const API_URL = "https://api.fake-rest.refine.dev";

const App: React.FC = () => {
    return (
        <BrowserRouter>
            <ConfigProvider theme={RefineThemes.Blue}>
                <Refine
                    routerProvider={routerProvider}
                    dataProvider={dataProvider(API_URL)}
                    authProvider={authProvider}
                    resources={[
                        {
                            name: "samples",
                            list: "/samples",
                        },
                    ]}
                >
                    <Routes>
                        <Route
                            element={
                                <ThemedLayout>
                                    <Outlet />
                                </ThemedLayout>
                            }
                        >
                            <Route
                                path="/samples"
                                element={<AntdInferencer />}
                            />
                        </Route>
                    </Routes>
                </Refine>
            </ConfigProvider>
        </BrowserRouter>
    );
};

note

<ThemedLayout> is designed to be responsive. In the live-preview, it appears in tablet mode and uses <Drawer>. On larger screens, it will use <Sider>.

info

Example of above showing how to use <ThemedLayout> with React Router v6. You can see these examples for other routers:

Props

`Sider`

In <ThemedLayout>, the sidebar section is rendered using the [<ThemedSider>][themed-sider] component by default. This component is specifically designed to generate menu items based on the resources defined in [<Refine>][refine-component] components, using the [useMenu][use-menu] hook. However, if desired, it's possible to replace the default [<ThemedSider>][themed-sider] component by passing a custom component to the Sider prop.

import { Refine } from "@refinedev/core";
import { ThemedLayout } from "@refinedev/antd";

import { CustomSider } from "./CustomSider";

const App: React.FC = () => {
    return (
        <Refine
        // ...
        >
            <ThemedLayout
                Sider={() => <CustomSider />}
            >
                {/* ... */}
            </ThemedLayout>
        </Refine>
    );
};

Also, you can customize the default [<ThemedSider>][themed-sider] component either by using its props or with the swizzle feature.

Here is an example of how to customize the default [<ThemedSider>][themed-sider] component using the render and Title prop:

import { Refine } from "@refinedev/core";
import { ThemedLayout, ThemedSider } from "@refinedev/antd";

import { CustomTitle } from "./CustomTitle";

const App: React.FC = () => {
    return (
        <Refine
        // ...
        >
            <ThemedLayout
                Sider={() => (
                    <ThemedSider
                        Title={({ collapsed }) => (
                            <CustomTitle collapsed={collapsed} />
                        )}
                        render={({ items, logout, collapsed }) => {
                            return (
                                <>
                                    <div>My Custom Element</div>
                                    {items}
                                    {logout}
                                </>
                            );
                        }}
                    />
                )}
            >
                {/* ... */}
            </ThemedLayout>
        </Refine>
    );
};

`Sider Props`

Prop	Type	Description
`Title`	`React.FC`	Component to render at the top
`render`	`SiderRenderFunction`	Function to render the menu items and other elements inside the `<ThemedSider>`
`meta`	`Record<string,any>`	Meta data to use when creating routes for the menu items

type SiderRenderFunction = (props: {
    items: JSX.Element[];
    logout: React.ReactNode;
    dashboard: React.ReactNode;
    collapsed: boolean;
}) => React.ReactNode;

`Header`

In <ThemedLayout>, the header section is rendered using the [<ThemedHeader>][themed-header] component by default. It uses useGetIdentity hook to display the user's name and avatar on the right side of the header. However, if desired, it's possible to replace the default [<ThemedHeader>][themed-header] component by passing a custom component to the Header prop.

Here is an example of how to replace the default [<ThemedHeader>][themed-header] component:

import { Refine } from "@refinedev/core";
import { ThemedLayout } from "@refinedev/antd";

import { CustomHeader } from "./CustomHeader";

const App: React.FC = () => {
    return (
        <Refine
        // ...
        >
            <ThemedLayout
                Header={() => <CustomHeader />}
            >
                {/* ... */}
            </ThemedLayout>
        </Refine>
    );
};

`Title`

In <ThemedLayout>, the title section is rendered using the [<ThemedTitle>][themed-title] component by default. However, if desired, it's possible to replace the default [<ThemedTitle>][themed-title] component by passing a custom component to the Title prop.

Here is an example of how to replace the default [<ThemedTitle>][themed-title] component:

import { Refine } from "@refinedev/core";
import { ThemedLayout, ThemedTitle } from "@refinedev/antd";

import { MyLargeIcon, MySmallIcon } from "./MyIcon";

const App: React.FC = () => {
    return (
        <Refine
        // ...
        >
            <ThemedLayout
                Title={({ collapsed }) => (
                    <ThemedTitle
                        // collapsed is a boolean value that indicates whether the <Sidebar> is collapsed or not
                        collapsed={collapsed}
                        icon={collapsed ? <MySmallIcon /> : <MyLargeIcon />}
                        text="My Project"
                    />
                )}
            >
                {/* ... */}
            </ThemedLayout>
        </Refine>
    );
};

`Footer`

The footer section of the layout is displayed at the bottom of the page. refine doesn't provide a default footer component. However, you can pass a custom component to the Footer prop to display a footer section.

Here is an example of how to display a footer section:

http://localhost:3000

import { Refine } from "@refinedev/core";
import { ThemedLayout, RefineThemes } from "@refinedev/antd";
import { ConfigProvider, Layout } from "antd";
import { AntdInferencer } from "@refinedev/inferencer/antd";

import routerProvider from "@refinedev/react-router-v6";
import { BrowserRouter, Routes, Route, Outlet } from "react-router-dom";

import dataProvider from "@refinedev/simple-rest";

import { authProvider } from "./authProvider";

const API_URL = "https://api.fake-rest.refine.dev";

const App: React.FC = () => {
    return (
        <BrowserRouter>
            <ConfigProvider theme={RefineThemes.Blue}>
                <Refine
                    routerProvider={routerProvider}
                    dataProvider={dataProvider(API_URL)}
                    authProvider={authProvider}
                    resources={[
                        {
                            name: "samples",
                            list: "/samples",
                        },
                    ]}
                >
                    <Routes>
                        <Route
                            element={
                                <ThemedLayout
                                    Footer={() => (
                                        <Layout.Footer
                                            style={{
                                                textAlign: "center",
                                                color: "#fff",
                                                backgroundColor: "#7dbcea",
                                            }}
                                        >
                                            My Custom Footer
                                        </Layout.Footer>
                                    )}
                                >
                                    <Outlet />
                                </ThemedLayout>
                            }
                        >
                            <Route path="samples">
                                <Route index element={<AntdInferencer />} />
                            </Route>
                        </Route>
                    </Routes>
                </Refine>
            </ConfigProvider>
        </BrowserRouter>
    );
};

import { Refine } from "@refinedev/core";
import { ThemedLayout } from "@refinedev/antd";
import { Layout } from "antd";

const App: React.FC = () => {
    return (
        <Refine
        // ...
        >
            <ThemedLayout
                Footer={() => (
                    <Layout.Footer
                        style={{
                            textAlign: "center",
                            color: "#fff",
                            backgroundColor: "#7dbcea",
                        }}
                    >
                        My Custom Footer
                    </Layout.Footer>
                )}
            >
                {/* ... */}
            </ThemedLayout>
        </Refine>
    );
};

`OffLayoutArea`

Used to component is rendered outside of the main layout component, allowing it to be placed anywhere on the page while still being part of the overall layout .refine doesn't provide a default off-layout area component. However, you can pass a custom component to the OffLayoutArea prop to display a custom off-layout area.

Here is an example of how to display a custom off-layout area:

http://localhost:3000

import { Refine } from "@refinedev/core";
import { ThemedLayout, RefineThemes } from "@refinedev/antd";
import { ConfigProvider, Button } from "antd";
import { AntdInferencer } from "@refinedev/inferencer/antd";

import routerProvider from "@refinedev/react-router-v6";
import { BrowserRouter, Routes, Route, Outlet } from "react-router-dom";

import dataProvider from "@refinedev/simple-rest";

import { authProvider } from "./authProvider";

const API_URL = "https://api.fake-rest.refine.dev";

const App: React.FC = () => {
    return (
        <BrowserRouter>
            <ConfigProvider theme={RefineThemes.Blue}>
                <Refine
                    routerProvider={routerProvider}
                    dataProvider={dataProvider(API_URL)}
                    authProvider={authProvider}
                    resources={[
                        {
                            name: "samples",
                            list: "/samples",
                        },
                    ]}
                >
                    <Routes>
                        <Route
                            element={
                                <ThemedLayout
                                    OffLayoutArea={() => (
                                        <Button
                                            type="primary"
                                            size="small"
                                            onClick={() =>
                                                alert("Off layout are clicked")
                                            }
                                            style={{
                                                position: "fixed",
                                                left: "8px",
                                                bottom: "8px",
                                                zIndex: 1000,
                                            }}
                                        >
                                            Send us Feedback 👋
                                        </Button>
                                    )}
                                >
                                    <Outlet />
                                </ThemedLayout>
                            }
                        >
                            <Route
                                path="/samples"
                                element={<AntdInferencer />}
                            />
                        </Route>
                    </Routes>
                </Refine>
            </ConfigProvider>
        </BrowserRouter>
    );
};

import { Refine } from "@refinedev/core";
import { ThemedLayout } from "@refinedev/antd";
import { Button } from "antd";

const App: React.FC = () => {
    return (
        <Refine
        // ...
        >
            <ThemedLayout
                OffLayoutArea={() => (
                    <Button
                        type="primary"
                        size="small"
                        onClick={() => alert("Off layout are clicked")}
                        style={{
                            position: "fixed",
                            left: "8px",
                            bottom: "8px",
                            zIndex: 1000,
                        }}
                    >
                        Send us Feedback 👋
                    </Button>
                )}
            >
                {/* ... */}
            </ThemedLayout>
        </Refine>
    );
};

Customizing with swizzle

🚨 This feature is available with @refine/cli. Please refer to CLI documentation for more information.

<ThemedLayout> component source code can be ejecting using the swizzle command. This will create a copy of the component in your project's src directory, allowing you to customize as your needs.

Usage

Let's create a new component by swizzling the <ThemedLayout> components.

> npm run refine swizzle

? Which package do you want to swizzle? (Use arrow keys or type to search)

Data Provider
 ◯ @refinedev/simple-rest
UI Framework
 ◉ @refinedev/antd

First, you need to select the package you want to swizzle. In this example, we will swizzle the @refinedev/antd package.

info

refine CLI will only show the packages that are installed in your project.

? Which component do you want to swizzle?

 ◯ TagField
 ◯ TextField
 ◯ UrlField
Other
 ◯ Breadcrumb
❯◉ ThemedLayout
Pages
 ◯ ErrorPage
 ◯ AuthPage
(Move up and down to reveal more choices)

Then, you need to select the component you want to swizzle. In this example, we will swizzle the ThemedLayout component.

Successfully swizzled Themed Layout
Files created:
 - src/components/themedLayout/sider.tsx
 - src/components/themedLayout/header.tsx
 - src/components/themedLayout/title.tsx
 - src/components/themedLayout/index.tsx

Warning:
If you want to change the default layout;
You should pass layout related components to the <ThemedLayout/> component's props.

    ╭ App.tsx ───────────────────────────────────────────────────────────────────────────────────────╮
    │                                                                                                │
    │   import { ThemedLayout } from "components/themedLayout";                                      │
    │   import { ThemedHeader } from "components/themedLayout/header";                               │
    │   import { ThemedSider } from "components/themedLayout/sider";                                 │
    │   import { ThemedTitle } from "components/themedLayout/title";                                 │
    │                                                                                                │
    │   const App = () => {                                                                          │
    │       return (                                                                                 │
    │           <Refine                                                                              │
    │               /* ... */                                                                        │
    │           >                                                                                    │
    │               <ThemedLayout Header={ThemedHeader} Sider={ThemedSider} Title={ThemedTitle} />   │
    │                   /* ... */                                                                    │
    │               </ThemedLayout>                                                                  │
    │           </Refine>                                                                            │
    │       );                                                                                       │
    │   }                                                                                            │
    │                                                                                                │
    ╰────────────────────────────────────────────────────────────────────────────────────────────────╯

Finally, the swizzle command will create a new folder in the src/components/layout directory and generate the layout components of the @refinedev/antd package in it.

You can use these components in your project as you wish.

import { Refine } from "@refinedev/core";
import { ThemedLayout } from "components/themedLayout";
import { ThemedHeader } from "components/themedLayout/header";
import { ThemedSider } from "components/themedLayout/sider";
import { ThemedTitle } from "components/themedLayout/title";

const App = () => {
    return (
        <Refine
        /* ... */
        >
            <ThemedLayout
                Header={ThemedHeader}
                Sider={ThemedSider}
                Title={ThemedTitle}
            >
                /* ... */
            </ThemedLayout>
        </Refine>
    );
};

info

refine CLI determines the path to create a new folder according to the framework you are using. For example, if you are using the remix, the path will be app/components/layout.

caution

If there is already a file with the same name in the directory, the swizzle command will not overwrite it.

Usage​

Props​

Sider​

Sider Props​

Header​

Title​

Footer​

OffLayoutArea​

Customizing with swizzle​

Usage​

Usage

Props

`Sider`

`Sider Props`

`Header`

`Title`

`Footer`

`OffLayoutArea`

Customizing with swizzle

Usage