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.
const { EditButton } = RefineAntd;
interface ICategory {
id: number;
title: string;
}
// visible-block-start
interface IPost {
id: number;
title: string;
content: string;
status: "published" | "draft" | "rejected";
category: { id: number };
}
import { Edit, useForm, useSelect } from "@refinedev/antd";
import { Form, Input, Select } from "antd";
const PostEdit: React.FC = () => {
const { formProps, saveButtonProps, query } = useForm<IPost>({
warnWhenUnsavedChanges: true,
});
const postData = query?.data?.data;
const { selectProps: categorySelectProps } = useSelect<ICategory>({
resource: "categories",
defaultValue: postData?.category.id,
});
return (
<Edit 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>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit/123"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton recordItemId="123">Edit Item 123</EditButton>
</div>
),
edit: PostEdit,
},
]}
/>,
);
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".
const { EditButton } = RefineAntd;
const { default: simpleRest } = RefineSimpleRest;
const dataProvider = simpleRest("https://api.fake-rest.refine.dev");
const customDataProvider = {
...dataProvider,
deleteOne: async ({ resource, id, variables }) => {
return {
data: {},
};
},
};
// visible-block-start
import { Edit } from "@refinedev/antd";
const PostEdit: React.FC = () => {
return (
<Edit title="Custom Title">
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit/2"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton recordItemId="2">Edit Item 2</EditButton>
</div>
),
edit: PostEdit,
},
]}
/>,
);
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:
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit } from "@refinedev/antd";
const PostEdit: React.FC = () => {
return (
<Edit saveButtonProps={{ size: "small" }}>
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit/2"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
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.
const { EditButton } = RefineAntd;
const { default: simpleRest } = RefineSimpleRest;
const dataProvider = simpleRest("https://api.fake-rest.refine.dev");
const customDataProvider = {
...dataProvider,
deleteOne: async ({ resource, id, variables }) => {
return {
data: {},
};
},
};
const authProvider = {
login: () => {
return {
success: true,
redirectTo: "/",
};
},
register: () => {
return {
success: true,
};
},
forgotPassword: () => {
return {
success: true,
};
},
updatePassword: () => {
return {
success: true,
};
},
logout: () => {
return {
success: true,
redirectTo: "/",
};
},
check: () => ({
authenticated: true,
}),
onError: () => ({}),
getPermissions: () => null,
getIdentity: () => null,
};
// visible-block-start
import { Edit } from "@refinedev/antd";
import { usePermissions } from "@refinedev/core";
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>
);
};
// visible-block-end
render(
<RefineAntdDemo
authProvider={authProvider}
dataProvider={customDataProvider}
initialRoutes={["/posts/edit/123"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton recordItemId="123">Edit Item 123</EditButton>
</div>
),
edit: PostEdit,
},
]}
/>,
);
For more information, refer to the
<DeleteButton>documentation →
For more information, refer to the
usePermissiondocumentation →
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:
setInitialRoutes(["/custom/2"]);
import { Refine } from "@refinedev/core";
import routerProvider from "@refinedev/react-router-v6/legacy";
import dataProvider from "@refinedev/simple-rest";
// visible-block-start
import { Edit } from "@refinedev/antd";
const CustomPage: React.FC = () => {
return (
<Edit resource="posts">
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
const App: React.FC = () => {
return (
<RefineAntdDemo
legacyRouterProvider={{
...routerProvider,
routes: [
{
element: <CustomPage />,
path: "/custom/:id",
},
],
}}
dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
resources={[{ name: "posts" }]}
/>
);
};
render(<App />);
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
identifiersection 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.
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit, useModalForm } from "@refinedev/antd";
import { Modal, Button } from "antd";
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>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit/2"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton recordItemId="2">Edit Item 2</EditButton>
</div>
),
edit: PostEdit,
},
]}
/>,
);
The <Edit> component needs the id information for the <RefreshButton> to work properly.
mutationMode
Determines which mode mutation will have while executing <DeleteButton> .
const { EditButton } = RefineAntd;
interface ICategory {
id: number;
title: string;
}
// visible-block-start
interface IPost {
id: number;
title: string;
content: string;
status: "published" | "draft" | "rejected";
category: { id: number };
}
import { Edit, useForm, useSelect } from "@refinedev/antd";
import { Form, Input, Select } from "antd";
const PostEdit: React.FC = () => {
const { formProps, saveButtonProps, query } = useForm<IPost>({
warnWhenUnsavedChanges: true,
});
const postData = query?.data?.data;
const { selectProps: categorySelectProps } = useSelect<ICategory>({
resource: "categories",
defaultValue: postData?.category.id,
});
return (
<Edit
mutationMode="undoable"
canDelete
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>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit/2"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton recordItemId="2">Edit Item 2</EditButton>
</div>
),
edit: PostEdit,
},
]}
/>,
);
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:
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit } from "@refinedev/antd";
import { Button } from "antd";
const PostEdit: React.FC = () => {
const BackButton = () => <Button>←</Button>;
return (
<Edit goBack={<BackButton />}>
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts", "/posts/edit/123"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton recordItemId="123">Edit Item 123</EditButton>
</div>
),
edit: PostEdit,
},
]}
/>,
);
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:
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit } from "@refinedev/antd";
const PostEdit: React.FC = () => {
return (
<Edit isLoading={true}>
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit/2"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
breadcrumb Globally ConfigurableThis 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.
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit, Breadcrumb } from "@refinedev/antd";
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>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
For more information, refer to the
Breadcrumbdocumentation →
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.
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit } from "@refinedev/antd";
const PostEdit: React.FC = () => {
return (
<Edit
wrapperProps={{
style: {
backgroundColor: "cornflowerblue",
padding: "16px",
},
}}
>
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
headerProps
You can use the headerProps property to customize the header of the <Edit/> component:
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit } from "@refinedev/antd";
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>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit/2"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
For more information, refer to the
PageHeaderdocumentation →
contentProps
You can use the contentProps property to customize the content of the <Edit/> component:
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit } from "@refinedev/antd";
const PostEdit: React.FC = () => {
return (
<Edit
contentProps={{
style: {
backgroundColor: "cornflowerblue",
padding: "16px",
},
}}
>
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
For more information, refer to the
Carddocumentation →
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.
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit } from "@refinedev/antd";
import { Button } from "antd";
const PostEdit: React.FC = () => {
return (
<Edit
headerButtons={({ defaultButtons }) => (
<>
{defaultButtons}
<Button type="primary">Custom Button</Button>
</>
)}
>
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit/2"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
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.
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit, ListButton, RefreshButton } from "@refinedev/antd";
import { Button } from "antd";
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>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit/2"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
headerButtonProps
You can use the headerButtonProps property to customize the wrapper element of the buttons at the header:
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit } from "@refinedev/antd";
import { Button } from "antd";
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>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
For more information, refer to the
Spacedocumentation →
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.
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit } from "@refinedev/antd";
import { Button } from "antd";
const PostEdit: React.FC = () => {
return (
<Edit
footerButtons={({ defaultButtons }) => (
<>
{defaultButtons}
<Button type="primary">Custom Button</Button>
</>
)}
>
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
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.
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit, SaveButton, DeleteButton } from "@refinedev/antd";
import { Button } from "antd";
const PostEdit: React.FC = () => {
return (
<Edit
footerButtons={({ saveButtonProps, deleteButtonProps }) => (
<>
<Button type="primary">Custom Button</Button>
<SaveButton {...saveButtonProps} hideText />
{deleteButtonProps && (
<DeleteButton {...deleteButtonProps} hideText />
)}
</>
)}
>
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
footerButtonProps
You can customize the wrapper element of the buttons at the footer by using the footerButtonProps property.
const { EditButton } = RefineAntd;
// visible-block-start
import { Edit } from "@refinedev/antd";
const PostEdit: React.FC = () => {
return (
<Edit
footerButtonProps={{
style: {
float: "right",
marginRight: 24,
backgroundColor: "cornflowerblue",
padding: "16px",
},
}}
>
<p>Rest of your page here</p>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton />
</div>
),
edit: PostEdit,
},
]}
/>,
);
For more information, refer to the
Spacedocumentation →
autoSaveProps
You can use the auto save feature of the <Edit/> component by using the autoSaveProps property.
const { EditButton } = RefineAntd;
interface ICategory {
id: number;
title: string;
}
interface IPost {
id: number;
title: string;
content: string;
status: "published" | "draft" | "rejected";
category: { id: number };
}
import { Edit, useForm, useSelect } from "@refinedev/antd";
import { Form, Input, Select } from "antd";
// visible-block-start
const PostEdit: React.FC = () => {
const {
formProps,
saveButtonProps,
query,
autoSaveProps,
} = useForm<IPost>({
warnWhenUnsavedChanges: true,
autoSave: {
enabled: true,
},
});
const postData = query?.data?.data;
const { selectProps: categorySelectProps } = useSelect<ICategory>({
resource: "categories",
defaultValue: postData?.category.id,
});
return (
<Edit
saveButtonProps={saveButtonProps}
autoSaveProps={autoSaveProps}
>
<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>
</Edit>
);
};
// visible-block-end
render(
<RefineAntdDemo
initialRoutes={["/posts/edit/123"]}
resources={[
{
name: "posts",
list: () => (
<div>
<p>This page is empty.</p>
<EditButton recordItemId="123">Edit Item 123</EditButton>
</div>
),
edit: PostEdit,
},
]}
/>,
);
API Reference
Properties
*: These properties have default values inRefineContextand can also be set on the <Refine> component.