Edit

<Edit> provides us a layout for displaying the page. It does not contain any logic but adds extra functionalities like a refresh button.

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

localhost:3000/custom/123

import { Edit } from "@refinedev/antd";

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

TIP

The example above shows how to use the resource prop when the component is rendered on a custom page with a different route than the resource route.

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 →

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 <Edit> component. If you don't pass title props, it uses the "Edit" prefix and the singular resource name by default. For example, for the "posts" resource, it will be "Edit post".

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/antd";

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

saveButtonProps

The <Edit> 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/edit/123

import { Edit } from "@refinedev/antd";

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

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

canDelete and deleteButtonProps

canDelete allows you to add a delete button inside the <Edit> component. This button uses the useDelete method provided by the dataProvider

If you want to customize this button you can use the deleteButtonProps property like the code below.

localhost:3000/posts/edit/123

const PostEdit: React.FC = () => {
  const { data: permissionsData } = usePermissions();
  return (
    <Edit
      canDelete={permissionsData?.includes("admin")}
      deleteButtonProps={{ size: "small" }}
      saveButtonProps={{ size: "small" }}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

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

For more information, refer to the usePermission documentation →

resource

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

localhost:3000/custom/123

import { Edit } from "@refinedev/antd";

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

TIP

The example above shows how to use the resource prop when the component is rendered on a custom page with a different route than the resource route.

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

recordItemId

The <Edit> component reads the id information from the route by default. When it cannot be read from the URL, which happens when it's used on a custom page, modal or drawer, recordItemId is used.

localhost:3000/posts/edit/123

const PostEdit: React.FC = () => {
  const { modalProps, id, show } = useModalForm({
    action: "edit",
  });

  return (
    <div>
      <Button onClick={() => show()}>Edit Button</Button>
      <Modal {...modalProps}>
        <Edit recordItemId={id}>
          <p>Rest of your page here</p>
        </Edit>
      </Modal>
    </div>
  );
};

The <Edit> component needs the id information for the <RefreshButton> to work properly.

mutationMode

Determines which mode mutation will have while executing <DeleteButton> .

localhost:3000/posts/edit/123

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

For more information, refer to the mutation mode documentation →

dataProviderName

If not specified, Refine will use the default data provider. If you have multiple data providers, you can use the dataProviderName property to specify which one you want to use:

import { Refine } from "@refinedev/core";
import dataProvider from "@refinedev/simple-rest";

import { Edit } from "@refinedev/antd";

const PostEdit = () => {
  return <Edit dataProviderName="other">...</Edit>;
};

export const App: React.FC = () => {
  return (
    <Refine
      dataProvider={{
        default: dataProvider("https://api.fake-rest.refine.dev/"),
        other: dataProvider("https://other-api.fake-rest.refine.dev/"),
      }}
    >
      {/* ... */}
    </Refine>
  );
};

goBack

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

localhost:3000/posts/edit/123

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

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 { Edit } from "@refinedev/antd";
import { Button } from "antd";

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

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

isLoading

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

localhost:3000/posts/edit/123

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

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/edit/123

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

For more information, refer to the Breadcrumb documentation →

wrapperProps

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

localhost:3000/posts/edit/123

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

headerProps

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

localhost:3000/posts/edit/123

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

For more information, refer to the PageHeader documentation →

contentProps

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

localhost:3000/posts/edit/123

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

For more information, refer to the Card documentation →

headerButtons

By default, the <Edit/> component has a <ListButton> and a <RefreshButton> at the header.

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

If the "list" resource is not defined, the <ListButton> will not render and listButtonProps will be undefined.

localhost:3000/posts/edit/123

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

Or, instead of using the defaultButtons, you can create your own buttons. If you want, you can use refreshButtonProps and listButtonProps to utilize the default values of the <ListButton>list-button and <RefreshButton>refresh-button components.

localhost:3000/posts/edit/123

const PostEdit: React.FC = () => {
  return (
    <Edit
      headerButtons={({ refreshButtonProps, listButtonProps }) => (
        <>
          <Button type="primary">Custom Button</Button>
          <RefreshButton {...refreshButtonProps} meta={{ foo: "bar" }} />
          {listButtonProps && (
            <ListButton {...listButtonProps} meta={{ foo: "bar" }} />
          )}
        </>
      )}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

headerButtonProps

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

localhost:3000/posts/edit/123

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

footerButtons

By default, the <Edit/> component has a <SaveButton> and a <DeleteButton> 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, deleteButtonProps }) => React.ReactNode which you can use to keep the existing buttons and add your own.

If canDelete is false, the <DeleteButton> will not render and deleteButtonProps will be undefined.

localhost:3000/posts/edit/123

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

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

localhost:3000/posts/edit/123

const PostEdit: React.FC = () => {
  return (
    <Edit
      footerButtons={({ saveButtonProps, deleteButtonProps }) => (
        <>
          <SaveButton {...saveButtonProps} hideText />
          {deleteButtonProps && (
            <DeleteButton {...deleteButtonProps} hideText />
          )}
        </>
      )}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

footerButtonProps

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

localhost:3000/posts/edit/123

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

autoSaveProps

You can use the auto save feature of the <Edit/> component by using the autoSaveProps property.

localhost:3000/posts/edit/123

const PostEdit: React.FC = () => {
  const { current, gotoStep, stepsProps, formProps, saveButtonProps, query } =
    useStepsForm<IPost>({
      stepsProps: {
        items: [
          {
            title: "First Step",
          },
          {
            title: "Second Step",
          },
        ],
      },
    });

  return (
    <Edit saveButtonProps={saveButtonProps}>
      <Steps {...stepsProps} />
      <Form {...formProps} layout="vertical">
        {current === 0 && (
          <Form.Item
            label="Title"
            name="title"
            rules={[
              {
                required: true,
              },
            ]}
          >
            <Input />
          </Form.Item>
        )}
        {current === 1 && (
          <Form.Item
            label="Content"
            name="content"
            rules={[
              {
                required: true,
              },
            ]}
          >
            <Input.TextArea />
          </Form.Item>
        )}
      </Form>
    </Edit>
  );
};

TIP

The query object from the useForm hook contains the query result from the data provider. You can use it to access the data returned from the API.

const { query } = useForm();
const record = query?.data?.data;

The data.data structure shown above is the default for the @refinedev/simple-rest data provider. This structure may be different for other data providers.

API Reference

Properties

Property	Type	Description	Default
resource	`string`	Resource name for API data interactions	Reads `:resource` from the URL
title	`ReactNode`	Title of the edit view	Edit {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
headerButtons	`ActionButtonRenderer<{ refreshButtonProps: RefreshButtonProps; listButtonProps: ListButtonProps; }>`	Header action buttons to be displayed in the header	If `recordItemId` is passed `<RefreshButton />` otherwise `<RefreshButton /> <ListButton />`
headerButtonProps	`SpaceProps`	Additional props to be passed to the wrapper of the header buttons
footerButtons	`ActionButtonRenderer<{ deleteButtonProps: DeleteButtonProps; saveButtonProps: SaveButtonProps; }>`	Footer action buttons to be displayed in the footer	If `canDelete` is passed `<SaveButton /> <DeleteButton />` otherwise `<SaveButton />`
footerButtonProps	`SpaceProps`	Additional props to be passed to the wrapper of the footer buttons
dataProviderName	`string`	To specify a data provider other than default use this property
isLoading	`boolean`	Loading state of the component	`false`
canDelete	`boolean`	Adds a `<DeleteButton />`	If the resource has `canDelete` prop it is `true` else `false`
saveButtonProps	`SaveButtonProps`	Additional props for the `<SaveButton />` component
deleteButtonProps	`DeleteButtonProps`	Adds properties for `<DeleteButton />`
mutationMode	`"pessimistic" \| "optimistic" \| "undoable"`	Determines when mutations are executed	`"pessimistic"`*
recordItemId	`BaseKey`	The record id for `<RefreshButton>`
autoSaveProps	`AutoSaveIndicatorProps`	Show <AutoSaveIndicator /> component on header buttons

External Props

It also accepts all props of Ant Design Form.

Type Parameters

Property	Extends	Default	Description
TQueryFnData	unknown	unknown	Result data returned by the query function. Extends unknown
TError	unknown	unknown	Custom error object that extends unknown
TVariables	object	object	Values for params. default `object`
TData	unknown	unknown	Result data returned by the `select` function. Extends unknown
TResponse	unknown	unknown	Result data returned by the mutation function. Extends unknown

Return values

Property	Description
`query`	If the `query` prop is given, it will be returned. Otherwise, it will return `undefined`.
`mutation`	Mutation result from `react-query`. Check here →
`saveButtonProps`	Props for a save button.
`cancelButtonProps`	Props for a cancel button.
`deleteButtonProps`	Props for a delete button.
`formProps`	Props for the `<Form>` component.
`formLoading`	Loading state of form.
`setId`	`id` setter.
`id`	Record id for edit action. The record to edit.
`defaultValues`	Default form values.
`formValues`	Form values.
`submit`	Submit method, the parameter is the values to update a record.
`reset`	Reset method, reset the form values to initial values.
`redirect`	Redirect function, will be called after form is submitted successfully.
`goBack`	Go back function, will be called when the cancel button is clicked.
`query`	Query result from `react-query`. Check here →

TIP

Properties​

title​

saveButtonProps​

canDelete and deleteButtonProps​

resource​

TIP

recordItemId​

mutationMode​

dataProviderName​

goBack​

isLoading​

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

wrapperProps​

headerProps​

contentProps​

headerButtons​

headerButtonProps​

footerButtons​

footerButtonProps​

autoSaveProps​

TIP

API Reference​

Properties​

External Props

Type Parameters​

Return values​

Properties

title

saveButtonProps

canDelete and deleteButtonProps

resource

recordItemId

mutationMode

dataProviderName

goBack

isLoading

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

wrapperProps

headerProps

contentProps

headerButtons

headerButtonProps

footerButtons

footerButtonProps

autoSaveProps

API Reference

Properties

Type Parameters

Return values