1. Adding List Page
In Unit 2.4, we created the CRUD pages automatically with Inferencer. In this unit, we will create the CRUD pages manually using the codes generated by Inferencer. So, you can customize the pages as you wish.
Creating List Page
First, let's create our file under the src/pages/blog-posts
folder. We will name it list.tsx
. Then, we will copy the list 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:
Navigate to the localhost:3000/blog-posts in your browser.
Click on the "Show Code" button in the bottom right corner of the page.
You can see the list page code generated by Inferencer. Click on the "Copy" button to copy the code.
Paste the code into the you created,
list.tsx
file.
You can see the list page code generated by Inferencer below:
Instead of coding the list page component from scratch, Inferencer created the required code base on API response, so that we can customize.
Understanding the List Component
We will go through the list page components and hooks one by one.
<List/>
is a refine component that is used to presentation purposes like showing create button or page title etc.<Table/>
is a native Chakra UI component that is used to display the data in a tabular format.useTable
hook, imported from@pankod/refine-react-table
package, has been developed by using the TanStack Table v8 package anduseTable
hook imported from@pankod/refine-core
package.It provides all the features of the
useTable
hook from@pankod/refine-core
package as well as theuseTable
hook from TanStack Table v8 package.It is used to fetch the data and manage the table state.
Refer to the @pankod/refine-react-table
useTable
documentation for more information →Refer to the TanStack Table v8 documentation for more information →
<EditButton/>
and<ShowButton/>
are refine components that are used to navigate to the edit and show pages of the record.Refer to the
<EditButton/>
documentation for more information →Refer to the
<ShowButton/>
documentation for more information →
Handling Relationships
Each blog post includes the category
field which has id
property. This is a foreign key that points to the categories
resource which is different than "blog_post" resource.
There is a title
field In the categories
resource. To display the category title
in the table, we can use the useMany
hook provided by refine.
This hook allows us to fetch data for multiple records in a single request by providing the id
's of the related records. In this case, we need to provide the id
's of the blog posts categories. It is particularly useful when we need to fetch related data for multiple records.
Refer to the useMany
documentation for more information →
In this tutorial, each blog post record has a category
field as below:
{
...
"category": {
"id": 1
}
...
},
{
...
"category": {
"id": 2
}
...
}
We can use the useMany
hook to fetch the full category records for each of these blog posts, like this:
import { useMany } from "@pankod/refine-core";
const { data } = useMany({
resource: "categories",
ids: blogPosts.map((blogPost) => blogPost.category.id),
});
This will pass the resource
and ids
to the dataProvider
's getMany
function. The dataProvider
will then make a single request to the API to fetch the full records for each category related to the blog posts. The resulting data
variable will be an array of category records, like this:
[
{
id: 1,
title: "mock category title",
},
{
id: 2,
title: "another mock category title",
},
];
We can then use this data
array to display the title
of each category in the table.
Adding the List Page to the App
Now that we have created the list page, we need to add it to the App.tsx
file.
Open
src/App.tsx
file on your editor.Import the created
BlogPostList
component.Replace the
ChakraUIInferencer
component with theBlogPostList
component.
import { Refine } from "@pankod/refine-core";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";
import {
ChakraProvider,
ErrorComponent,
Layout,
refineTheme,
ReadyPage,
useNotificationProvider,
} from "@pankod/refine-chakra-ui";
import { ChakraUIInferencer } from "@pankod/refine-inferencer/chakra-ui";
import { BlogPostList } from "pages/blog-posts/list";
const App = () => {
return (
<ChakraProvider theme={refineTheme}>
<Refine
notificationProvider={notificationProvider()}
routerProvider={routerProvider}
dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
Layout={Layout}
ReadyPage={ReadyPage}
catchAll={<ErrorComponent />}
resources={[
{
name: "blog_posts",
list: BlogPostList,
edit: ChakraUIInferencer,
show: ChakraUIInferencer,
create: ChakraUIInferencer,
},
]}
/>
</ChakraProvider>
);
};
export default App;
Now, we can see the list page in the browser at localhost:3000/blog-posts