Skip to main content
Refine AI
RefineDocumentation
Version: 4.xx.xx
Swizzle Ready

Create

<Create> provides us a layout to display the page. It does not contain any logic but adds extra functionalities like action buttons and giving titles to the page.

We will show what <Create> does using properties with examples.

localhost:3000/posts/create
import { Create, useForm, useSelect } from "@refinedev/antd";
import { Form, Input, Select } from "antd";

const PostCreate: React.FC = () => {
  const { formProps, saveButtonProps } = useForm<IPost>();

  const { selectProps: categorySelectProps } = useSelect<ICategory>({
    resource: "categories",
  });

  return (
    <Create saveButtonProps={saveButtonProps}>
      <Form {...formProps} layout="vertical">
        <Form.Item
          label="Title"
          name="title"
          rules={[
            {
              required: true,
            },
          ]}
        >
          <Input />
        </Form.Item>
        <Form.Item
          label="Category"
          name={["category", "id"]}
          rules={[
            {
              required: true,
            },
          ]}
        >
          <Select {...categorySelectProps} />
        </Form.Item>
        <Form.Item
          label="Status"
          name="status"
          rules={[
            {
              required: true,
            },
          ]}
        >
          <Select
            options={[
              {
                label: "Published",
                value: "published",
              },
              {
                label: "Draft",
                value: "draft",
              },
              {
                label: "Rejected",
                value: "rejected",
              },
            ]}
          />
        </Form.Item>
      </Form>
    </Create>
  );
};
Good to know:

You can swizzle this component to customize it with the Refine CLI

Properties​

title​

title allows you to add a title inside the <Create> component. If you don't pass the title props, it uses the "Create" prefix and the singular resource name by default. For example, for the /posts/create resource, it would be "Create post".

localhost:3000/posts/create
import { Create } from "@refinedev/antd";

const PostCreate: React.FC = () => {
  return (
    <Create title="Custom Title">
      <p>Rest of your page here</p>
    </Create>
  );
};

saveButtonProps​

The <Create> component has a save button that submits the form by default. If you want to customize this button you can use the saveButtonProps property:

localhost:3000/posts/create
import { Create } from "@refinedev/antd";

const PostCreate: React.FC = () => {
  return (
    <Create saveButtonProps={{ size: "small" }}>
      <p>Rest of your page here</p>
    </Create>
  );
};

For more information, refer to the <SaveButton> documentation →

resource​

The <Create> component reads the resource information from the route by default. If you want to use a custom resource for the <Create> component, you can use the resource prop:

localhost:3000/custom
import { Create } from "@refinedev/antd";

const MyComponent: React.FC = () => {
  return (
    <Create resource="posts">
      <p>Rest of your page here</p>
    </Create>
  );
};

If you have multiple resources with the same name, you can pass the identifier instead of the name of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name of the resource defined in the <Refine/> component.

For more information, refer to the identifier section of the <Refine/> component documentation →

goBack​

To customize the back button or to disable it, you can use the goBack property:

localhost:3000/posts/create
import { Create } from "@refinedev/antd";
import { Button } from "antd";

const PostCreate: React.FC = () => {
  const BackButton = () => <Button>←</Button>;
  return (
    <Create goBack={<BackButton />}>
      <p>Rest of your page here</p>
    </Create>
  );
};

If your route has no :action parameter or your action is list, the back button will not be shown even if you pass a goBack property. You can override this behavior by using the headerProps property:

import { useBack } from "@refinedev/core";
import { Create } from "@refinedev/antd";
import { Button } from "antd";

const PostCreate: React.FC = () => {
  const back = useBack();
  const BackButton = () => <Button>←</Button>;

  return (
    <Create goBack={<BackButton />} headerProps={{ onBack: back }}>
      <p>Rest of your page here</p>
    </Create>
  );
};

isLoading​

To toggle the loading state of the <Create/> component, you can use the isLoading property:

localhost:3000/posts/create
import { Create } from "@refinedev/antd";

const PostCreate: React.FC = () => {
  return (
    <Create isLoading={true}>
      <p>Rest of your page here</p>
    </Create>
  );
};

breadcrumb
Globally Configurable
This value can be configured globally. Click to see the guide for more information.
​

To customize or disable the breadcrumb, you can use the breadcrumb property. By default the Breadcrumb component from the @refinedev/antd package is used for breadcrumbs.

localhost:3000/posts/create
import { Create, Breadcrumb } from "@refinedev/antd";

const PostCreate: React.FC = () => {
  return (
    <Create
      breadcrumb={
        <div
          style={{
            padding: "3px 6px",
            border: "2px dashed cornflowerblue",
          }}
        >
          <Breadcrumb />
        </div>
      }
    >
      <p>Rest of your page here</p>
    </Create>
  );
};

For more information, refer to the Breadcrumb documentation →

wrapperProps​

You can use the wrapperProps property if you want to customize the wrapper of the <Create/> component. The @refinedev/antd wrapper elements are simply <div/>s and wrapperProps and can get every attribute that <div/> can get.

localhost:3000/posts/create
import { Create } from "@refinedev/antd";

const PostCreate: React.FC = () => {
  return (
    <Create
      wrapperProps={{
        style: {
          backgroundColor: "cornflowerblue",
          padding: "16px",
        },
      }}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};

headerProps​

You can use the headerProps property to customize the header of the <Create/> component:

localhost:3000/posts/create
import { Create } from "@refinedev/antd";

const PostCreate: React.FC = () => {
  return (
    <Create
      headerProps={{
        subTitle: "This is a subtitle",
        style: {
          backgroundColor: "cornflowerblue",
          padding: "16px",
        },
      }}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};

For more information, refer to the PageHeader documentation →

contentProps​

You can use the contentProps property to customize the content of the <Create/> component:

localhost:3000/posts/create
import { Create } from "@refinedev/antd";

const PostCreate: React.FC = () => {
  return (
    <Create
      contentProps={{
        style: {
          backgroundColor: "cornflowerblue",
          padding: "16px",
        },
      }}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};

For more information, refer to the Card documentation →

headerButtons​

You can customize the buttons at the header by using the headerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons }) => React.ReactNode which you can use to keep the existing buttons and add your own.

localhost:3000/posts/create
import { Create } from "@refinedev/antd";
import { Button } from "antd";

const PostCreate: React.FC = () => {
  return (
    <Create
      headerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};

headerButtonProps​

You can use the headerButtonProps property to customize the wrapper element of the buttons at the header:

localhost:3000/posts/create
import { Create } from "@refinedev/antd";
import { Button } from "antd";

const PostCreate: React.FC = () => {
  return (
    <Create
      headerButtonProps={{
        style: {
          backgroundColor: "cornflowerblue",
          padding: "16px",
        },
      }}
      headerButtons={<Button type="primary">Custom Button</Button>}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};

For more information, refer to the Space documentation →

footerButtons​

By default, the <Create/> component has a <SaveButton> at the footer.

You can customize the buttons at the footer by using the footerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons, saveButtonProps }) => React.ReactNode which you can use to keep the existing buttons and add your own.

localhost:3000/posts/create
import { Create } from "@refinedev/antd";
import { Button } from "antd";

const PostCreate: React.FC = () => {
  return (
    <Create
      footerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};

Or, instead of using the defaultButtons, you can create your own buttons. If you want, you can use saveButtonProps to utilize the default values of the <SaveButton> component.

localhost:3000/posts/create
import { Create, SaveButton } from "@refinedev/antd";
import { Button } from "antd";

const PostCreate: React.FC = () => {
  return (
    <Create
      footerButtons={({ saveButtonProps }) => (
        <>
          <SaveButton
            {...saveButtonProps}
            type="primary"
            style={{ marginRight: 8 }}
          >
            Save
          </SaveButton>
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};

footerButtonProps​

You can customize the wrapper element of the buttons at the footer by using the footerButtonProps property.

localhost:3000/posts/create
import { Create } from "@refinedev/antd";
import { Button } from "antd";

const PostCreate: React.FC = () => {
  return (
    <Create
      footerButtonProps={{
        style: {
          float: "right",
          marginRight: 24,
          backgroundColor: "cornflowerblue",
          padding: "16px",
        },
      }}
    >
      <p>Rest of your page here</p>
    </Create>
  );
};

For more information, refer to the Space documentation →

API Reference​

Properties​

PropertyTypeDescriptionDefault
resource

string

Resource name for API data interactions

Reads :resource from the URL

title

ReactNode

Title of the create view

Create {resource.name}

wrapperProps

DetailedHTMLProps<HTMLDivElement>

Props for the wrapper component of the view

headerProps

PageHeaderProps

Props for the header component

contentProps

CardProps

Props for the content wrapper component

breadcrumb

ReactNode

Breadcrumb to be displayed in the header

<Breadcrumb />

goBack

ReactNode

Back button element at the top left of the page

<ArrowLeft />

headerButtons

ActionButtonRenderer<Record<string

number

symbol, unknown>>

Header action buttons to be displayed in the header

null

headerButtonProps

SpaceProps

Additional props to be passed to the wrapper of the header buttons

footerButtons

ActionButtonRenderer<{ saveButtonProps: SaveButtonProps; }>

Footer action buttons to be displayed in the footer

<SaveButton />

footerButtonProps

SpaceProps

Additional props to be passed to the wrapper of the footer buttons

isLoading

boolean

Loading state of the component

false

saveButtonProps

SaveButtonProps

Additional props for the <SaveButton /> component

Previous
Inferencer
Next
Edit