Skip to main content
Version: 3.xx.xx

3. Adding Show Page

Show page is the page where you can see the record. In this tutorial, we will create the show page for the products resource.

Creating Show Page

First, let's create our file under the src/pages/products folder. We will name it show.tsx. Then, we will copy the show page code generated by Inferencer and paste it into the file.

To copy the code and paste it into the file, follow the steps below:

  1. Navigate to the localhost:3000/products in your browser.

  2. To open the show page, click any "Show" button in the "Actions" column of the table.

  3. On the show page, click on the "Show Code" button in the bottom right corner of the page.

  4. You can see the show page code generated by Inferencer. Click on the "Copy" button to copy the code.

  5. Paste the code into the you created, show.tsx file.

You can see the show page code generated by Inferencer below:

http://localhost:3000/products/show/123

Instead of coding the show page component from scratch, Inferencer created the required code base on API response, so that we can customize.

Understanding the Show Component

We will go through the show page components and hooks one by one.

Handling Relationships

In the show page, we have a single record. The record may have relationships with other resources.

For example, the products resource has a relationship with the categories resource. In this case, we can use the useOne hook provided by refine. This hook allows us to fetch single record data by using the id and resource parameters.

Refer to the useOne documentation for more information

In the auto-generated show page code, Inferencer used the useOne hook to fetch the category data of the product record.

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

To ensure that the related data is only fetched after the product record has been successfully retrieved, we can use the queryOptions object. By setting the enabled property to true only if the record variable is truthy, we can control when the related data is fetched like below:

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

Adding the Show Page to the App

Now that we have created the show page, we need to add it to the App.tsx file.

  1. Open src/App.tsx file on your editor.

  2. Import the created ProductShow component.

  3. Replace the MantineInferencer component with the ProductShow component.

src/App.tsx
import { Refine } from "@pankod/refine-core";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";
import {
MantineProvider,
Global,
NotificationsProvider,
notificationProvider,
LightTheme,
Layout,
ReadyPage,
ErrorComponent,
} from "@pankod/refine-mantine";
import { MantineInferencer } from "@pankod/refine-inferencer/mantine";

import { ProductList } from "pages/products/list";
import { ProductEdit } from "pages/products/edit";
import { ProductShow } from "pages/products/show";

const App = () => {
return (
<MantineProvider theme={LightTheme} withNormalizeCSS withGlobalStyles>
<Global styles={{ body: { WebkitFontSmoothing: "auto" } }} />
<NotificationsProvider position="top-right">
<Refine
routerProvider={routerProvider}
dataProvider={dataProvider(
"https://api.fake-rest.refine.dev",
)}
notificationProvider={notificationProvider}
ReadyPage={ReadyPage}
catchAll={<ErrorComponent />}
Layout={Layout}
resources={[
{
name: "products",
list: ProductList,
edit: ProductEdit,
/highlight-next-line
show: ProductShow,
create: MantineInferencer,
},
]}
/>
</NotificationsProvider>
</MantineProvider>
);
};
export default App;

Now, we can see the show page in the browser at localhost:3000/products/show/123



Checklist