Skip to main content
Version: 3.xx.xx

Edit

<EditButton> uses Ant Design's <Button> component. It uses the edit method from useNavigation under the hood. It can be useful when redirecting the app to the edit page with the record id route of resource.

Usage

import {
List,
Table,
useTable,
EditButton,
} from "@pankod/refine-antd";

export const PostList: React.FC = () => {
const { tableProps } = useTable<IPost>();

return (
<List>
<Table {...tableProps} rowKey="id">
<Table.Column dataIndex="id" title="ID" />
<Table.Column dataIndex="title" title="Title" />
<Table.Column<IPost>
title="Actions"
dataIndex="actions"
key="actions"
render={(_, record) => (
<EditButton size="small" recordItemId={record.id} />
)}
/>
</Table>
</List>
);
};

interface IPost {
id: string;
title: string;
}

Will look like this:

Default edit button

Properties

recordItemId

recordItemId is used to append the record id to the end of the route path.

import { EditButton } from "@pankod/refine-antd";

export const MyEditComponent = () => {
return <EditButton resourceName="posts" recordItemId="1" />;
};

Clicking the button will trigger the edit method of useNavigation and then redirect the app to /posts/edit/1.

note

<EditButton> component reads the id information from the route by default.

resourceNameOrRouteName

Redirection endpoint(resourceNameOrRouteName/edit) is defined by resourceNameOrRouteName property. By default, <EditButton> uses name property of the resource object as an endpoint to redirect after clicking.

import { EditButton } from "@pankod/refine-antd";

export const MyEditComponent = () => {
return <EditButton resourceNameOrRouteName="categories" recordItemId="2" />;
};

Clicking the button will trigger the edit method of useNavigation and then redirect the app to /categories/edit/2.

hideText

It is used to show and not show the text of the button. When true, only the button icon is visible.

import { EditButton } from "@pankod/refine-antd";

export const MyEditComponent = () => {
return <EditButton hideText />;
};

ignoreAccessControlProvider

It is used to skip access control for the button so that it doesn't check for access control. This is relevant only when an accessControlProvider is provided to <Refine/>

import { EditButton } from "@pankod/refine-antd";

export const MyListComponent = () => {
return <EditButton ignoreAccessControlProvider />;
};

API Reference

Properties

PropertyDescriptionTypeDefault
propsAnt Design button propertiesButtonProps & { resourceName?: string; recordItemId?: BaseKey; hideText?: boolean; }
resourceNameOrRouteNameDetermines which resource to use for redirectionstringResource name that it reads from route
resourceName
deprecated
Determines which resource to use for redirectionstringResource name that it reads from route
recordItemIdAdds id to the end of the URLBaseKeyRecord id that it reads from route
hideTextAllows to hide button textbooleanfalse
ignoreAccessControlProviderSkip access controlbooleanfalse
childrenSets the button textReactNode"Edit"
iconSets the icon component of buttonReactNode<EditOutlined />
onClickSets the handler to handle click event(event) => voidTriggers navigation for redirection to the edit page of resource