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 list page hooks one by one.

• useShow is a refine hook that is used to get single record data by using the id in the URL. It sends the parameters to the dataProvider's getOne function and returns the result.

  Refer to the useShow documentation for more information →

• useNavigation is a refine hook that is used to navigate between pages. In this case, we are using it to navigate to the edit and list pages when the user clicks on the "Edit" and "Products List" buttons.

  Refer to the useNavigation documentation for more information →

• useResource is a refine hook that is used to get current resource information and resources that are defined on the <Refine/>.

  Refer to the useResource documentation for more information →

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 HeadlessInferencer component with the ProductShow component.

src/App.tsx

import { Refine } from "@refinedev/core";
import routerBindings, {
    UnsavedChangesNotifier,
} from "@refinedev/react-router-v6";
import dataProvider from "@refinedev/simple-rest";
import { HeadlessInferencer } from "@refinedev/inferencer/headless";
import { BrowserRouter, Routes, Route, Outlet } from "react-router-dom";

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

const App = () => {
    return (
        <BrowserRouter>
            <Refine
                routerProvider={routerBindings}
                dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
                resources={[
                    {
                        name: "products",
                        list: "/products",
                        show: "/products/show/:id",
                        create: "/products/create",
                        edit: "/products/edit/:id",
                    },
                ]}
                options={{
                    syncWithLocation: true,
                    warnWhenUnsavedChanges: true,
                }}
            >
                <Routes>
                    <Route path="products">
                        <Route index element={<ProductList />} />
                        <Route path="show/:id" element={<ProductShow />} />
                        <Route path="edit/:id" element={<ProductEdit />} />
                        <Route path="create" element={<HeadlessInferencer />} />
                    </Route>
                </Routes>
                <UnsavedChangesNotifier />
            </Refine>
        </BrowserRouter>
    );
};
export default App;

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

Checklist

I added the show page to the app.

I understood the show page components and hooks.

I understood the relationship handling.