Skip to main content
Unlock powerful debugging and effortless query monitoring with Refine DevtoolsLearn More
RefineDocumentation
Version: 4.xx.xx
Swizzle 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.

localhost:3000/posts/show/2
import { Show, MarkdownField } from "@refinedev/antd";
import { Typography } from "antd";
import { useShow, useOne } from "@refinedev/core";

const { Title, Text } = Typography;

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

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

  return (
    <Show isLoading={isLoading}>
      <Title level={5}>Id</Title>
      <Text>{record?.id}</Text>

      <Title level={5}>Title</Title>
      <Text>{record?.title}</Text>

      <Title level={5}>Category</Title>
      <Text>{categoryIsLoading ? "Loading..." : categoryData?.data.title}</Text>

      <Title level={5}>Content</Title>
      <MarkdownField value={record?.content} />
    </Show>
  );
};
Good to know:

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

Properties​

title​

title allows you to add a 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".

localhost:3000/posts/show/2
import { Show } from "@refinedev/antd";

const PostShow: React.FC = () => {
  return (
    <Show title="Custom Title">
      <p>Rest of your page here</p>
    </Show>
  );
};

resource​

The <Show> component reads the resource information from the route by default. If you want to use a custom resource for the <Show> component, you can use the resource prop:

localhost:3000/custom/2
import { Show } from "@refinedev/antd";

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

If you have multiple resources with the same name, you can pass the identifier instead of the name of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name of the resource defined in the <Refine/> component.

For more information, refer to the identifier of the <Refine/> component documentation →

canDelete and canEdit​

canDelete and canEdit allows us to add the delete and edit buttons inside the <Show> component.

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

localhost:3000/posts/show/2
import { Show } from "@refinedev/antd";
import { usePermissions } from "@refinedev/core";

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

For more information, refer to the usePermission documentation →

For more information, refer to the <DeleteButton> and the <EditButton> documentations.

recordItemId​

The<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).

localhost:3000/posts/show/2
import { Show, useModalForm } from "@refinedev/antd";
import { Modal, Button } from "antd";

const PostShow: React.FC = () => {
  const { modalProps, id, show } = useModalForm({
    action: "show",
  });

  return (
    <div>
      <Button onClick={() => show()}>Show Button</Button>
      <Modal {...modalProps}>
        <Show recordItemId={id}>
          <p>Rest of your page here</p>
        </Show>
      </Modal>
    </div>
  );
};

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

dataProviderName​

If not specified, Refine will use the default data provider. If you have multiple data providers, you can use the dataProviderName property to specify which one you want to use:

import { Refine } from "@refinedev/core";
import dataProvider from "@refinedev/simple-rest";

import { Show } from "@refinedev/antd";

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

export const App: React.FC = () => {
  return (
    <Refine
      dataProvider={{
        default: dataProvider("https://api.fake-rest.refine.dev/"),
        other: dataProvider("https://other-api.fake-rest.refine.dev/"),
      }}
    >
      {/* ... */}
    </Refine>
  );
};

goBack​

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

localhost:3000/posts/show/2
import { Show } from "@refinedev/antd";
import { Button } from "antd";

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

If your route has no :action parameter or your action is list, the back button will not be shown even if you pass a goBack property. You can override this behavior by using the headerProps property:

import { useBack } from "@refinedev/core";
import { Show } from "@refinedev/antd";
import { Button } from "antd";

const PostShow: React.FC = () => {
  const back = useBack();
  const BackButton = () => <Button>←</Button>;

  return (
    <Show goBack={<BackButton />} headerProps={{ onBack: back }}>
      <p>Rest of your page here</p>
    </Show>
  );
};

isLoading​

Since <Show> uses the Ant Design <Card> component, the isLoading property can be set like the below:

localhost:3000/posts/show/2
import { Show } from "@refinedev/antd";

const PostShow: React.FC = () => {
  return (
    <Show isLoading={true}>
      <p>Rest of your page here</p>
    </Show>
  );
};

breadcrumb
Globally Configurable
This value can be configured globally. Click to see the guide for more information.
​

To customize or disable the breadcrumb, you can use the breadcrumb property. By default the Breadcrumb component from the @refinedev/antd package is used for breadcrumbs.

localhost:3000/posts/show/2
import { Show, Breadcrumb } from "@refinedev/antd";

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

For more information, refer to the Breadcrumb documentation →

wrapperProps​

You can use the wrapperProps property if you want to customize the wrapper of the <Show/> component. The @refinedev/antd wrapper elements are simply <div/>s and wrapperProps and can get every attribute that <div/> can get.

localhost:3000/posts/show/2
import { Show } from "@refinedev/antd";

const PostShow: React.FC = () => {
  return (
    <Show
      wrapperProps={{
        style: {
          backgroundColor: "cornflowerblue",
          padding: "16px",
        },
      }}
    >
      <p>Rest of your page here</p>
    </Show>
  );
};

headerProps​

You can use the headerProps property to customize the header of the <Show/> component:

localhost:3000/posts/show/2
import { Show } from "@refinedev/antd";

const PostShow: React.FC = () => {
  return (
    <Show
      headerProps={{
        subTitle: "This is a subtitle",
        style: {
          backgroundColor: "cornflowerblue",
          padding: "16px",
        },
      }}
    >
      <p>Rest of your page here</p>
    </Show>
  );
};

For more information, refer to the PageHeader documentation →

contentProps​

You can use the contentProps property to customize the content of the <Show/> component:

localhost:3000/posts/show/2
import { Show } from "@refinedev/antd";

const PostShow: React.FC = () => {
  return (
    <Show
      contentProps={{
        style: {
          backgroundColor: "cornflowerblue",
          padding: "16px",
        },
      }}
    >
      <p>Rest of your page here</p>
    </Show>
  );
};

For more information, refer to the Card documentation →

headerButtons​

By default, the <Show/> component has a <ListButton>, <EditButton>, <DeleteButton>, and a <RefreshButton> at the header.

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

If the "list" resource is not defined, the <ListButton> will not render and listButtonProps will be undefined.

If canDelete is false, the <DeleteButton> will not render and deleteButtonProps will be undefined.

If canEdit is false, <EditButton> will not render and editButtonProps will be undefined.

localhost:3000/posts/show/2
import { Show } from "@refinedev/antd";
import { Button } from "antd";

const PostShow: React.FC = () => {
  return (
    <Show
      headerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <p>Rest of your page here</p>
    </Show>
  );
};

Or, instead of using the defaultButtons, you can create your own buttons. If you want, you can use createButtonProps to utilize the default values of the <ListButton>, <EditButton>, <DeleteButton>, and <RefreshButton> components.

localhost:3000/posts/show/2
import {
  Show,
  ListButton,
  EditButton,
  DeleteButton,
  RefreshButton,
} from "@refinedev/antd";
import { Button } from "antd";

const PostShow: React.FC = () => {
  return (
    <Show
      headerButtons={({
        deleteButtonProps,
        editButtonProps,
        listButtonProps,
        refreshButtonProps,
      }) => (
        <>
          <Button type="primary">Custom Button</Button>
          {listButtonProps && (
            <ListButton {...listButtonProps} meta={{ foo: "bar" }} />
          )}
          {editButtonProps && (
            <EditButton {...editButtonProps} meta={{ foo: "bar" }} />
          )}
          {deleteButtonProps && (
            <DeleteButton {...deleteButtonProps} meta={{ foo: "bar" }} />
          )}
          <RefreshButton {...refreshButtonProps} meta={{ foo: "bar" }} />
        </>
      )}
    >
      <p>Rest of your page here</p>
    </Show>
  );
};

headerButtonProps​

You can use the headerButtonProps property to customize the wrapper element of the buttons at the header:

localhost:3000/posts/edit/2
import { Show } from "@refinedev/antd";
import { Button } from "antd";

const PostShow: React.FC = () => {
  return (
    <Show
      headerButtonProps={{
        style: {
          backgroundColor: "cornflowerblue",
          padding: "16px",
        },
      }}
      headerButtons={<Button type="primary">Custom Button</Button>}
    >
      <p>Rest of your page here</p>
    </Show>
  );
};

For more information, refer to the Space documentation →

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.

localhost:3000/posts/show/2
import { Show } from "@refinedev/antd";
import { Button } from "antd";

const PostShow: React.FC = () => {
  return (
    <Show
      footerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <p>Rest of your page here</p>
    </Show>
  );
};

footerButtonProps​

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

localhost:3000/posts/show/2
import { Show } from "@refinedev/antd";
import { Button } from "antd";

const PostShow: React.FC = () => {
  return (
    <Show
      footerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
      footerButtonProps={{
        style: {
          float: "right",
          marginRight: 24,
          backgroundColor: "cornflowerblue",
          padding: "16px",
        },
      }}
    >
      <p>Rest of your page here</p>
    </Show>
  );
};

For more information, refer to the Space documentation →

API Reference​

Properties​

PropertyTypeDescriptionDefault
resource

string

Resource name for API data interactions

Reads :resource from the URL

title

ReactNode

Title of the edit view

Show {resource.name}

wrapperProps

DetailedHTMLProps<HTMLDivElement>

Props for the wrapper component of the view

headerProps

PageHeaderProps

Props for the header component

contentProps

CardProps

Props for the content wrapper component

breadcrumb

ReactNode

Breadcrumb to be displayed in the header

<Breadcrumb>

goBack

ReactNode

Back button element at the top left of the page

<ArrowLeft />

headerButtons

ActionButtonRenderer<{ editButtonProps: EditButtonProps; deleteButtonProps: DeleteButtonProps; refreshButtonProps: RefreshButtonProps

undefined; listButtonProps: ListButtonProps

undefined; }>

Header action buttons to be displayed in the header

ListButton, RefreshButton, EditButton and DeleteButton

headerButtonProps

SpaceProps

Additional props to be passed to the wrapper of the header buttons

footerButtons

ActionButtonRenderer<Record<string

number

symbol, unknown>>

Footer action buttons to be displayed in the footer

null

footerButtonProps

SpaceProps

Additional props to be passed to the wrapper of the footer buttons

dataProviderName

string

To specify a data provider other than default use this property

isLoading

boolean

Loading state of the component

false

canDelete

boolean

Adds a <DeleteButton />

If the resource has canDelete prop it is true else false

canEdit

boolean

Adds a <EditButton />

If the resource is passed a edit component, true else false

recordItemId

BaseKey

The record id for <RefreshButton />

Previous
List
Next
Clone