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

Show

http://localhost:3000
Live previews only work with the latest documentation.
const { default: simpleRest } = RefineSimpleRest
setRefineProps({
  dataProvider: simpleRest('https://api.fake-rest.refine.dev'),
  Layout: RefineChakra.Layout,
  Sider: () => null,
})

const Wrapper = ({ children }) => {
  return (
    <RefineChakra.ChakraProvider theme={RefineChakra.refineTheme}>
      {children}
    </RefineChakra.ChakraProvider>
  )
}

const DummyListPage = () => (
  <RefineChakra.VStack alignItems="flex-start">
    <RefineChakra.Text>This page is empty.</RefineChakra.Text>
    <ShowButton colorScheme="black" recordItemId="123">
      Show Item 123
    </ShowButton>
  </RefineChakra.VStack>
)

interface ICategory {
  id: number
  title: string
}

interface IPost {
  id: number
  title: string
  content: string
  status: 'published' | 'draft' | 'rejected'
  category: { id: number }
}

<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
Live previews only work with the latest documentation.
import { useShow, useOne } from '@pankod/refine-core'
import {
  Show,
  Heading,
  Text,
  MarkdownField,
  Spacer,
} from '@pankod/refine-chakra-ui'

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

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

  return (
    <Show isLoading={isLoading}>
      <Heading as="h5" size="sm">
        Id
      </Heading>
      <Text mt={2}>{record?.id}</Text>

      <Heading as="h5" size="sm" mt={4}>
        Title
      </Heading>
      <Text mt={2}>{record?.title}</Text>

      <Heading as="h5" size="sm" mt={4}>
        Status
      </Heading>
      <Text mt={2}>{record?.status}</Text>

      <Heading as="h5" size="sm" mt={4}>
        Category
      </Heading>
      <Text mt={2}>{categoryData?.data?.title}</Text>

      <Heading as="h5" size="sm" mt={4}>
        Content
      </Heading>
      <Spacer mt={2} />
      <MarkdownField value={record?.content} />
    </Show>
  )
}
Swizzle

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

Properties​

title​

It allows adding a title for 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
Live previews only work with the latest documentation.
import { Show, Heading } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show title={<Heading size="lg">Custom Title</Heading>}>
      <p>Rest of your page here</p>
    </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. &#8594

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

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

const App: React.FC = () => {
  return (
    <Refine
      routerProvider={{
        ...routerProvider,
        routes: [
          {
            element: <CustomPage />,
            path: '/custom/:id',
          },
        ],
      }}
      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
Live previews only work with the latest documentation.
import { Show } from '@pankod/refine-chakra-ui'
import { usePermissions } from '@pankod/refine-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>
  )
}

Refer to the usePermission documentation for detailed usage. &#8594

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
Live previews only work with the latest documentation.
import { useModalForm } from '@pankod/refine-react-hook-form'
import {
  Show,
  Modal,
  Button,
  ModalOverlay,
  ModalContent,
  ModalCloseButton,
  ModalHeader,
  ModalBody,
} from '@pankod/refine-chakra-ui'

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

  return (
    <div>
      <Button onClick={() => show()}>Edit Button</Button>
      <Modal isOpen={visible} onClose={close} size="xl">
        <ModalOverlay />
        <ModalContent>
          <ModalCloseButton />
          <ModalHeader>Show</ModalHeader>

          <ModalBody>
            <Show recordItemId={id}>
              <p>Rest of your page here</p>
            </Show>
          </ModalBody>
        </ModalContent>
      </Modal>
    </div>
  )
}
note

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

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

http://localhost:3000
Live previews only work with the latest documentation.
import { Show } from '@pankod/refine-chakra-ui'
import { IconMoodSmile } from '@tabler/icons'

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

isLoading​

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

http://localhost:3000
Live previews only work with the latest documentation.
import { Show } from '@pankod/refine-chakra-ui'

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

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

Refer to the Breadcrumb documentation for detailed usage. &#8594

tip

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

http://localhost:3000
Live previews only work with the latest documentation.
import { Show, Box, Breadcrumb } from '@pankod/refine-chakra-ui'

const CustomBreadcrumb: React.FC = () => {
  return (
    <Box borderColor="blue" borderStyle="dashed" borderWidth="2px">
      <Breadcrumb />
    </Box>
  )
}

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

wrapperProps​

If you want to customize the wrapper of the <Show/> component, you can use the wrapperProps property. For @pankod/refine-chakra-ui wrapper element is <Box>s and wrapperProps can get every attribute that <Card> can get.

Refer to the Box documentation from Chakra UI for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Show } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show
      wrapperProps={{
        borderColor: 'blue',
        borderStyle: 'dashed',
        borderWidth: '2px',
        p: '2',
      }}
    >
      <p>Rest of your page here</p>
    </Show>
  )
}

headerProps​

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

Refer to the Box documentation from Chakra UI for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Show } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show
      headerProps={{
        borderColor: 'blue',
        borderStyle: 'dashed',
        borderWidth: '2px',
      }}
    >
      <p>Rest of your page here</p>
    </Show>
  )
}

contentProps​

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

Refer to the Box documentation from Chakra UI for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Show } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show
      contentProps={{
        borderColor: 'blue',
        borderStyle: 'dashed',
        borderWidth: '2px',
        p: '2',
      }}
    >
      <p>Rest of your page here</p>
    </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
Live previews only work with the latest documentation.
import { Show, Button, HStack, Box } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show
      headerButtons={({ defaultButtons }) => (
        <HStack>
          {defaultButtons}
          <Button colorScheme="red">Custom Button</Button>
        </HStack>
      )}
    >
      <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.

Refer to the Box documentation from Chakra UI for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Show, Button } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show
      headerButtonProps={{
        borderColor: 'blue',
        borderStyle: 'dashed',
        borderWidth: '2px',
        p: '2',
      }}
      headerButtons={
        <Button variant="outline" colorScheme="green">
          Custom Button
        </Button>
      }
    >
      <p>Rest of your page here</p>
    </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
Live previews only work with the latest documentation.
import { Show, Button, HStack } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show
      footerButtons={({ defaultButtons }) => (
        <HStack borderColor="blue" borderStyle="dashed" borderWidth="2px" p="2">
          {defaultButtons}
          <Button colorScheme="red" variant="solid">
            Custom Button
          </Button>
        </HStack>
      )}
    >
      <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.

Refer to the Space documentation from Ant Design for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Show, Button } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show
      footerButtonProps={{
        style: {
          float: 'right',
          borderColor: 'blue',
          borderStyle: 'dashed',
          borderWidth: '2px',
          padding: '8px',
        },
      }}
      footerButtons={<Button colorScheme="green">Custom Button</Button>}
    >
      <p>Rest of your page here</p>
    </Show>
  )
}

API Reference​

Props​