Skip to main content
Refine AI
RefineDocumentation
Version: 4.xx.xx
Swizzle Ready

Show

<Show> provides us a layout for displaying the page. It does not contain any logic and just adds extra functionalities like a refresh button and being able to give titles to the page.

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

localhost:3000/posts/show/123
import { useShow } from "@refinedev/core";
import { Show, MarkdownField } from "@refinedev/mantine";
import { Title, Text } from "@mantine/core";

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

  return (
    <Show isLoading={isLoading}>
      <Title order={5}>Id</Title>
      <Text mt="sm">{record?.id}</Text>

      <Title mt="sm" order={5}>
        Title
      </Title>
      <Text mt="sm">{record?.title}</Text>

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

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

Properties​

title​

title allows the addition of titles 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 would be "Show post".

localhost:3000/posts/show/123
import { Show } from "@refinedev/mantine";
import { Title } from "@mantine/core";

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

resource​

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

localhost:3000/custom/123
import { Show } from "@refinedev/mantine";

const CustomPage: React.FC = () => {
  return (
    <Show resource="categories">
      <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 section of the <Refine/> component documentation →

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.

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

localhost:3000/posts/show/123
import { Show } from "@refinedev/mantine";
import { usePermissions } from "@refinedev/core";
import { Title } from "@mantine/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 →

recordItemId​

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

localhost:3000/posts/show/123
import { Show, useModalForm } from "@refinedev/mantine";
import { Modal, Button } from "@mantine/core";

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

  return (
    <div>
      <Button onClick={() => show()}>Show Button</Button>
      <Modal
        opened={visible}
        onClose={close}
        size={700}
        withCloseButton={false}
      >
        <Show recordItemId={id}>
          <p>Rest of your page here</p>
        </Show>
      </Modal>
    </div>
  );
};

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 "@refinedev/core";
import { Show } from "@refinedev/mantine";
import dataProvider from "@refinedev/simple-rest";

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. You can pass false or null to hide the back button.

localhost:3000/posts/show/123
import { Show } from "@refinedev/mantine";

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

isLoading​

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

localhost:3000/posts/show/123
import { Show } from "@refinedev/mantine";

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 it uses the Breadcrumb component from @refinedev/mantine package.

localhost:3000/posts/show/123
import { Show } from "@refinedev/mantine";

const CustomBreadcrumb: React.FC = () => {
  return (
    <p
      style={{
        padding: "3px 6px",
        border: "2px dashed cornflowerblue",
      }}
    >
      My Custom Breadcrumb
    </p>
  );
};

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

For more information, refer to the Breadcrumb documentation →

wrapperProps​

If you want to customize the wrapper of the <Show/> component, you can use the wrapperProps property. For @refinedev/mantine wrapper element is <Card>s and wrapperProps can get every attribute that <Card> can get.

localhost:3000/posts/show/123
import { Show } from "@refinedev/mantine";

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

For more information, refer to the Card documentation from Mantine →

headerProps​

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

localhost:3000/posts/show/123
import { Show } from "@refinedev/mantine";

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

For more information, refer to the Group documentation from Mantine →

contentProps​

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

localhost:3000/posts/show/123
import { Show } from "@refinedev/mantine";

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

For more information, refer to the Box documentation from Mantine →

headerButtons​

By default, the <Show/> component has a <ListButton>, <EditButton>, <DeleteButton>, and, <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, deleteButtonProps, editButtonProps, listButtonProps, 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/123
import { Show } from "@refinedev/mantine";
import { Button } from "@mantine/core";

const PostShow: React.FC = () => {
  return (
    <Show
      headerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button variant="outline" 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/123
import {
  Show,
  ListButton,
  EditButton,
  DeleteButton,
  RefreshButton,
} from "@refinedev/mantine";
import { Button } from "@mantine/core";

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

headerButtonProps​

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

localhost:3000/posts/show/123
import { Show } from "@refinedev/mantine";
import { Button } from "@mantine/core";

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

Refer to the Group documentation from Mantine for detailed usage. →

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/123
import { Show } from "@refinedev/mantine";
import { Button } from "@mantine/core";

const PostShow: React.FC = () => {
  return (
    <Show
      footerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button variant="gradient">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/123
import { Show } from "@refinedev/mantine";
import { Button } from "@mantine/core";

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

For more information, refer to the Box documentation from Mantine →

API Reference​

Props​

PropertyTypeDescriptionDefault
resource

string

Resource name for API data interactions

Reads :resource from the URL

title

ReactNode

Title of the edit view

<Title order={3}>Show {resource.name}</Title>
wrapperProps

CardProps

Props for the wrapper component of the view

headerProps

GroupProps

Props for the header component

contentProps

BoxProps

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

headerButtons

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

undefined; listButtonProps: ListButtonProps

undefined; }>

Header action buttons to be displayed in the header

headerButtonProps

GroupProps

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

GroupProps

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

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