Back to Refine

4. Adding Create Page

documentation/versioned_docs/version-3.xx.xx/tutorial/4-adding-crud-pages/chakra-ui/add-create-page.md

3.25.06.7 KB
Original Source

Create page is the page where you can create the record. In this tutorial, we will create the create page for the blog_posts resource.

Creating Create Page

First, let's create our file under the src/pages/blog-posts folder. We will name it create.tsx. Then, we will copy the create 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 <a href="http://localhost:3000/blog-posts" rel="noopener noreferrer nofollow">localhost:3000/blog-posts</a> in your browser.

  2. To open the create page, click the "Create" button in the top right corner of the table.

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

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

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

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

tsx
setInitialRoutes(["/blog-posts/create"]);

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";

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: ChakraUIInferencer,
            show: ChakraUIInferencer,
            create: ChakraUIInferencer,
            edit: ChakraUIInferencer,
          },
        ]}
      />
    </ChakraProvider>
  );
};

render(<App />);

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

Understanding the Create Component

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

Handling Relationships

In the create 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 resource name to the dataProvider's getList method. Then, it returns the options to be used in the <Select/> component.

Refer to the useSelect documentation for more information &#8594

Refer to the Chakra UI <Select/> documentation for more information &#8594

In the auto-generated create page code, Inferencer used the useSelect hook to select a category from the categories resource like below:

tsx
const { options: categoryOptions } = useSelect({
  resource: "categories",
});

Adding the Create Page to the App

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

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

  2. Import the created BlogPostCreate component.

  3. Replace the ChakraUIInferencer component with the BlogPostCreate component.

tsx
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";
import { BlogPostEdit } from "pages/blog-posts/edit";
import { BlogPostShow } from "pages/blog-posts/show";
//highlight-next-line
import { BlogPostCreate } from "pages/blog-posts/create";

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: BlogPostEdit,
            show: BlogPostShow,
            //highlight-next-line
            create: BlogPostCreate,
          },
        ]}
      />
    </ChakraProvider>
  );
};
export default App;

Now, we can see the create page in the browser at <a href="http://localhost:3000/blog-posts/create" rel="noopener noreferrer nofollow">localhost:3000/blog-posts/create</a>

<Checklist> <ChecklistItem id="add-create-page-chakra-ui"> I added the create page to the app. </ChecklistItem> <ChecklistItem id="add-create-page-chakra-ui-2"> I understood the create page components and hooks. </ChecklistItem> <ChecklistItem id="add-create-page-chakra-ui-3"> I understood the relationship handling. </ChecklistItem> </Checklist>