Skip to main content
Version: 3.xx.xxSwizzle Ready

Show

<Show> provides us a layout for displaying the page. It does not contain any logic but adds extra functionalities like a refresh button or giving title to the page.

We will show what <Show> does using properties with examples.

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import React from "react";
import { useShow, useOne } from "@pankod/refine-core";
import {
    Show,
    Stack,
    Typography,
    NumberField,
    TextFieldComponent as TextField,
    MarkdownField,
    DateField,
} from "@pankod/refine-mui";

const SampleShow = () => {
    const { queryResult } = useShow();
    const { data, isLoading } = queryResult;

    const record = data?.data;

    const { data: categoryData, isLoading: categoryIsLoading } = useOne({
        resource: "categories",
        id: record?.category?.id || "",
        queryOptions: {
            enabled: !!record,
        },
    });

    return (
        <Show isLoading={isLoading}>
            <Stack gap={1}>
                <Typography variant="body1" fontWeight="bold">
                    Id
                </Typography>
                <NumberField value={record?.id ?? ""} />
                <Typography variant="body1" fontWeight="bold">
                    Title
                </Typography>
                <TextField value={record?.title} />
                <Typography variant="body1" fontWeight="bold">
                    Content
                </Typography>
                <MarkdownField value={record?.content} />
                <Typography variant="body1" fontWeight="bold">
                    Category
                </Typography>
                {categoryIsLoading ? (
                    <>Loading...</>
                ) : (
                    <>{categoryData?.data?.title}</>
                )}
                <Typography variant="body1" fontWeight="bold">
                    Created At
                </Typography>
                <DateField value={record?.createdAt} />
            </Stack>
        </Show>
    );
};
Swizzle

You can swizzle this component to customize it with the refine CLI

Properties​

title​

It allows adding title inside the <Show> component. if you don't pass title props it uses the "Show" prefix and the singular resource name by default. For example, for the "posts" resource, it will be "Show post".

http://localhost:3000/posts/create
Live previews only work with the latest documentation.
import { Show, Typography } from "@pankod/refine-mui";

const ShowPage: React.FC = () => {
    return (
        <Show
            title={<Typography variant="h5">Custom Title</Typography>}
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

resource​

The <Show> component reads the resource information from the route by default. This default behavior will not work on custom pages. If you want to use the <Show> component in a custom page, you can use the resource property.

Refer to the custom pages documentation for detailed usage. →

http://localhost:3000/custom
Live previews only work with the latest documentation.
import { Refine } from "@pankod/refine-core";
import { Show, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";

const CustomPage: React.FC = () => {
    return (
        <Show resource="posts" recordItemId={123}>
            <span>Rest of your page here</span>
        </Show>
    );
};

const App: React.FC = () => {
    return (
        <Refine
            routerProvider={{
                ...routerProvider,
                routes: [
                    {
                        element: <CustomPage />,
                        path: "/custom",
                    },
                ],
            }}
            Layout={Layout}
            dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
            resources={[{ name: "posts" }]}
        />
    );
};

canDelete and canEdit​

canDelete and canEdit allows us to add the delete and edit buttons inside the <Show> component. If the resource has canDelete or canEdit property refine adds the buttons by default.

When clicked on, delete button executes the useDelete method provided by the dataProvider and the edit button redirects the user to the record edit page.

Refer to the <DeleteButton> and the <EditButton> documentation for detailed usage.

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show } from "@pankod/refine-mui";
import { usePermissions } from "@pankod/refine-core";

const PostShow: React.FC = () => {
    const { data: permissionsData } = usePermissions();
    return (
        <Show
            canDelete={permissionsData?.includes("admin")}
            canEdit={permissionsData?.includes("editor") || permissionsData?.includes("admin")}
        >
            <p>Rest of your page here</p>
        </Show>
    );
};

Refer to the usePermission documentation for detailed usage. →

recordItemId​

<Show> component reads the id information from the route by default. recordItemId is used when it cannot read from the URL (when used on a custom page, modal or drawer).

http://localhost:3000/custom
Live previews only work with the latest documentation.
import { Refine } from "@pankod/refine-core";
import { List, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";

const CustomPage: React.FC = () => {
    return (
        <List resource="posts" recordItemId={123}>
            <span>Rest of your page here</span>
        </List>
    );
};

const App: React.FC = () => {
    return (
        <Refine
            routerProvider={{
                ...routerProvider,
                routes: [
                    {
                        element: <CustomPage />,
                        path: "/custom",
                    },
                ],
            }}
            Layout={Layout}
            dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
            resources={[{ name: "posts" }]}
        />
    );
};
note

<Show> component needs the id information for <RefreshButton> to work properly.

caution

The <Show> component needs the id information for work properly, so if you use the <Show> component in custom pages, you should pass the recordItemId property.

dataProviderName​

If not specified, Refine will use the default data provider. If you have multiple data providers and want to use a different one, you can use the dataProviderName property.

import { Refine } from "@pankod/refine-core";
import { Show } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";

const PostShow = () => {
    return <Show dataProviderName="other">...</Show>;
};

export const App: React.FC = () => {
    return (
        <Refine
            routerProvider={routerProvider}
            dataProvider={{
                default: dataProvider("https://api.fake-rest.refine.dev/"),
                other: dataProvider("https://other-api.fake-rest.refine.dev/"),
            }}
            resources={[{ name: "posts", show: PostShow }]}
        />
    );
};

goBack​

To customize the back button or to disable it, you can use the goBack property.

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show, Button } from "@pankod/refine-mui";
import { useNavigation } from "@pankod/refine-core";

const BackButton = () => {
    const { goBack } = useNavigation();

    return <Button onClick={() => goBack()}>BACK!</Button>
}

const PostShow: React.FC = () => {
    return (
        <Show
            goBack={<BackButton />}
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

isLoading​

To toggle the loading state of the <Show/> component, you can use the isLoading property.

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show } from "@pankod/refine-mui";

const PostShow: React.FC = () => {
    const [loading, setLoading] = React.useState(true);

    return (
        <Show
            isLoading={loading}
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

To customize or disable the breadcrumb, you can use the breadcrumb property. By default it uses the Breadcrumb component from @pankod/refine-mui package.

Refer to the Breadcrumb documentation for detailed usage. →

tip

This feature can be managed globally via the <Refine> component's options

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show, Breadcrumb } from "@pankod/refine-mui";

const PostShow: React.FC = () => {
    return (
        <Show
            breadcrumb={
                <div
                    style={{
                        padding: "3px 6px",
                        border: "2px dashed cornflowerblue",
                    }}
                >
                    <Breadcrumb />
                </div>
            }
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

wrapperProps​

If you want to customize the wrapper of the <Show/> component, you can use the wrapperProps property.

Refer to the Card documentation from Material UI for detailed usage. →

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show } from "@pankod/refine-mui";

const PostShow: React.FC = () => {
    const [loading, setLoading] = React.useState(true);

    return (
        <Show
            wrapperProps={{
                sx: {
                    backgroundColor: "lightsteelblue",
                },
            }}
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

headerProps​

If you want to customize the header of the <Show/> component, you can use the headerProps property.

Refer to the CardHeader documentation from Material UI for detailed usage. →

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show } from "@pankod/refine-mui";

const PostShow: React.FC = () => {
    const [loading, setLoading] = React.useState(true);

    return (
        <Show
            headerProps={{
                sx: {
                    backgroundColor: "lightsteelblue",
                },
            }}
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

contentProps​

If you want to customize the content of the <Show/> component, you can use the contentProps property.

Refer to the CardContent documentation from Material UI for detailed usage. →

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show } from "@pankod/refine-mui";

const PostShow: React.FC = () => {
    const [loading, setLoading] = React.useState(true);

    return (
        <Show
            contentProps={{
                sx: {
                    backgroundColor: "lightsteelblue",
                },
            }}
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

headerButtons​

You can customize the buttons at the header by using the headerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons }) => React.ReactNode which you can use to keep the existing buttons and add your own.

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show, Button } from "@pankod/refine-mui";

const PostShow: React.FC = () => {
    const [loading, setLoading] = React.useState(true);

    return (
        <Show
            headerButtons={({ defaultButtons }) => (
                <>
                    {defaultButtons}
                    <Button type="primary">Custom Button</Button>
                </>
            )}
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

headerButtonProps​

You can customize the wrapper element of the buttons at the header by using the headerButtonProps property.

Refer to the Box documentation from Material UI for detailed usage. →

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show, Button } from "@pankod/refine-mui";

const PostShow: React.FC = () => {
    const [loading, setLoading] = React.useState(true);

    return (
        <Show
            headerButtonProps={{
                sx: {
                    backgroundColor: "lightsteelblue",
                },
            }}
            headerButtons={({ defaultButtons }) => (
                <>
                    {defaultButtons}
                    <Button type="primary">Custom Button</Button>
                </>
            )}
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

footerButtons​

You can customize the buttons at the footer by using the footerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons }) => React.ReactNode which you can use to keep the existing buttons and add your own.

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show, Button } from "@pankod/refine-mui";

const PostShow: React.FC = () => {
    const [loading, setLoading] = React.useState(true);

    return (
        <Show
            footerButtons={({ defaultButtons }) => (
                <>
                    {defaultButtons}
                    <Button type="primary">Custom Button</Button>
                </>
            )}
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

footerButtonProps​

You can customize the wrapper element of the buttons at the footer by using the footerButtonProps property.

Refer to the CardActions documentation from Material UI for detailed usage. →

http://localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show, Button } from "@pankod/refine-mui";

const PostShow: React.FC = () => {
    const [loading, setLoading] = React.useState(true);

    return (
        <Show
            footerButtonProps={{
                sx: {
                    backgroundColor: "lightsteelblue",
                },
            }}
            footerButtons={({ defaultButtons }) => (
                <>
                    {defaultButtons}
                    <Button type="primary">Custom Button</Button>
                </>
            )}
        >
            <span>Rest of your page here</span>
        </Show>
    );
};

actionButtons​

Deprecated

Use headerButtons or footerButtons instead.

<Show> uses the Material UI <CardActions> component. By default,The children of the <CardActions> component shows nothing in the <Show> component.

src/pages/posts/show.tsx
import { Show, Button } from "@pankod/refine-mui";

export const ShowPage: React.FC = () => {
    return (
        <Show
            actionButtons={
                <>
                    <Button type="primary">Custom Button 1</Button>
                    <Button type="default">Custom Button 2</Button>
                </>
            }
        >
            ...
        </Show>
    );
};

cardProps​

Deprecated

Use wrapperProps instead.

<Show> uses the Material UI <Card> components so you can customize with the props of cardProps.

cardHeaderProps​

Deprecated

Use headerProps instead.

<Show> uses the Material UI <CardHeader> components so you can customize with the props of cardHeaderProps.

src/pages/posts/show.tsx
import { useShow } from "@pankod/refine-core";
import { Show, Typography, Stack } from "@pankod/refine-mui";

export const ShowPage: React.FC = () => {
    const { queryResult } = useShow<IPost>();
    const { data, isLoading } = queryResult;
    const record = data?.data;

    return (
        <Show
            isLoading={isLoading}
            cardHeaderProps={{
                title: <Typography variant="h5">Custom Title</Typography>,
            }}
        >
            <Stack gap="10px">
                <Typography fontWeight="bold">Id</Typography>
                <Typography>{record?.id}</Typography>
                <Typography fontWeight="bold">Title</Typography>
                <Typography>{record?.title}</Typography>
            </Stack>
        </Show>
    );
};

interface IPost {
    id: number;
    title: string;
}

cardContentProps​

Deprecated

Use contentProps instead.

<Show> uses the Material UI <CardContent> components so you can customize with the props of cardContentProps.

cardActionsProps​

Deprecated

Use headerButtonProps and footerButtonProps instead.

<Show> uses the Material UI <CardActions> components so you can customize with the props of cardActionsProps.

API Reference​

Properties​