2. Adding Edit Page
Edit page is the page where you can edit the record. In this tutorial, we will create the edit page for the blog_posts
resource.
Creating Edit Page
First, let's create our file under the src/pages/blog-posts
folder. We will name it edit.tsx
. Then, we will copy the edit 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.
To open the edit page, click any "Edit" button in the "Actions" column of the table.
On the edit page, click on the "Show Code" button in the bottom right corner of the page.
You can see the edit page code generated by Inferencer. Click on the "Copy" button to copy the code.
Paste the code into the you created,
edit.tsx
file.
You can see the edit page code generated by Inferencer below:
Instead of coding the edit page component from scratch, Inferencer created the required code base on API response, so that we can customize.
Understanding the Edit Component
We will go through the edit page components and hooks one by one.
<Edit/>
is a refine component that is used to presentation purposes like showing the title of the page, save button, refresh button etc.<Form/>
and<Form.Item/>
are Ant Design components that are used to build the form.Refer to the Ant Design
<Form/>
documentation for more information →useForm
is a refine hook that provides the necessary props for the form. It also provides thesaveButtonProps
prop that we can pass to the submit button of the form.When you use
useForm
in the edit page, it automatically fetches the data of the record by using theid
in the URL, then fills the form with the data. It sends the form data todataProvider
'supdate
method when the form is submitted.
Handling Relationships
In the edit page, we may need to select a record from another resource.
For example, we may need to select a category from the categories
resource to assign the blog post to the category. In this case, we can use the useSelect
hook provided by refine. This hook fetches the data by passing the params to the dataProvider
's getList
method. Then, it returns the necessary props for the <Select/>
component.
Refer to the useSelect
documentation for more information →
Refer to the Ant Design <Select/>
documentation for more information →
In the auto-generated edit page code, Inferencer used the useSelect
hook to select a category from the categories
resource like below:
const { selectProps: categorySelectProps } = useSelect({
resource: "categories",
});
useSelect
returns 10 record by default, but the category of the blog post may not be in the first 10 records. To solve this problem, we can use the defaultValue
prop to set the default value of the select component like below:
const { selectProps: categorySelectProps } = useSelect({
resource: "categories",
defaultValue: blogPostsData?.category?.id,
});
Adding the Edit Page to the App
Now that we have created the edit page, we need to add it to the App.tsx
file.
Open
src/App.tsx
file on your editor.Import the created
BlogPostEdit
component.Replace the
AntdInferencer
component with theBlogPostEdit
component.
import { Refine } from "@pankod/refine-core";
import {
Layout,
ReadyPage,
useNotificationProvider,
ErrorComponent,
} from "@pankod/refine-antd";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";
import { AntdInferencer } from "@pankod/refine-inferencer/antd";
import { BlogPostList } from "pages/blog-posts/list";
import { BlogPostEdit } from "pages/blog-posts/edit";
import "@pankod/refine-antd/dist/reset.css";
const App: React.FC = () => {
return (
<Refine
routerProvider={routerProvider}
dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
Layout={Layout}
ReadyPage={ReadyPage}
notificationProvider={useNotificationProvider}
catchAll={<ErrorComponent />}
resources={[
{
name: "blog_posts",
list: BlogPostList,
edit: BlogPostEdit,
show: AntdInferencer,
create: AntdInferencer,
},
]}
/>
);
};
export default App;
Now, we can see the edit page in the browser at localhost:3000/blog-posts/edit/123