Skip to main content
Version: 3.xx.xx

Delete

<DeleteButton> uses Ant Design's <Button> and <Popconfirm> components. When you try to delete something, a pop-up shows up and asks for confirmation. When confirmed it executes the useDelete method provided by your dataProvider.

Usage​

import {
DeleteButton,
List,
Table,
useTable,
} 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"
render={(_, record) => (
<DeleteButton size="small" recordItemId={record.id} />
)}
/>
</Table>
</List>
);
};

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

Will look like this:

Default delete button

When clicked, it opens the confirmation window like this:

Confirmation window

Properties​

recordItemId​

recordItemId allows us to manage which record will be deleted.

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

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

Clicking the button will trigger the useDelete method and then the record whose resource is "post" and whose id is "1" gets deleted.

note

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

resourceName​

resourceNameOrRouteName allows us to manage which resource's record is going to be deleted.

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

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

Clicking the button will trigger the useDelete method and then the record whose resource is "categories" and whose id is "2" gets deleted.

note

<DeleteButton> component reads the resource name from the route by default.

onSuccess​

onSuccess can be used if you want to do anything on the result returned after the delete request.

For example, let's console.log after deletion:

import { List, Table, DeleteButton, useTable } 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"
render={(_, record) => (
<DeleteButton
size="small"
recordItemId={record.id}
onSuccess={(value) => {
console.log(value);
}}
/>
)}
/>
</Table>
</List>
);
};

mutationMode​

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

Refer to the mutation mode docs for further information. β†’

import { List, Table, DeleteButton, useTable } 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"
render={(_, record) => (
<DeleteButton
size="small"
recordItemId={record.id}
mutationMode="undoable"
/>
)}
/>
</Table>
</List>
);
};

hideText​

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

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

export const MyDeleteComponent = () => {
return <DeleteButton 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 { DeleteButton } from "@pankod/refine-antd";

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

How to override confirm texts?​

You can change the text that appears when you confirm a transaction with confirmTitle prop, as well as what ok and cancel buttons text look like with confirmOkText and confirmCancelText props.

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

export const MyDeleteComponent = () => {
return (
<DeleteButton
confirmTitle="Title"
confirmOkText="Ok Text"
confirmCancelText="Delete Text"
/>
);
};

API Reference​

Properties​

PropertyDescriptionTypeDefault
propsAnt Design button propertiesButtonProps & DeleteButtonProps
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
recordItemIdDetermines which id to use for deletionBaseKeyRecord id that it reads from route
onSuccessCalled when mutation is successful(value: DeleteOneResponse) => void
mutationModeDetermines when mutations are executed."pessimistic" | "optimistic" | "undoable"
hideTextAllows to hide button textbooleanfalse
confirmTitleThe title of the confirmation boxstring"Are you sure?"
confirmOkTextThe text of the Confirm buttonstring"Delete"
confirmCancelTextThe text of the Cancel buttonstring"Cancel"
childrenSets the button textReactNode"Delete"
ignoreAccessControlProviderSkip access controlbooleanfalse
iconSets the icon component of the buttonReactNode<DeleteOutlined />
dangerSets the danger status of the buttonbooleantrue
loadingSets the loading status of the buttonbooleanWhen the request is not completed, loading is true, when it completes it's false
metaDataMetadata query for dataProviderMetaDataQuery{}
invalidatesYou can use it to manage the invalidations that will occur at the end of the mutation.all, resourceAll, list, many, detail, false["list", "many"]