Delete
<DeleteButton>
uses Material UI's <LoadingButton>
and <Dialog>
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
.
You can swizzle this component with the refine CLI to customize it.
Usage
Properties
recordItemId
recordItemId
allows us to manage which record will be deleted.
Clicking the button will trigger the useDelete
method and then the record whose resource is post
and whose id is 1
gets deleted.
<DeleteButton>
component reads the id information from the route by default.
resource
resource
allows us to manage which resource's record is going to be deleted.
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 →
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:
mutationMode
Determines which mode mutation will have while executing <DeleteButton>
.
import { useTable } from "@refinedev/core";
import {
List,
DeleteButton,
} from "@refinedev/mui";
import {
Table,
TableHead,
TableRow,
TableCell,
TableBody,
} from "@mui/x-data-grid";
export const PostList: React.FC = () => {
const { tableQueryResult } = useTable<IPost>();
const { data } = tableQueryResult;
return (
<List>
<Table aria-label="simple table">
<TableHead>
<TableRow>
<TableCell>ID</TableCell>
<TableCell>Title</TableCell>
<TableCell align="center">Action</TableCell>
</TableRow>
</TableHead>
<TableBody>
{data?.data.map((row) => (
<TableRow key={row.id}>
<TableCell>{row.id}</TableCell>
<TableCell component="th" scope="row">
{row.title}
</TableCell>
<TableCell align="center">
<DeleteButton
recordItemId={row.id}
mutationMode="undoable"
/>
</TableCell>
</TableRow>
))}
</TableBody>
</Table>
</List>
);
};
interface IPost {
id: number;
title: string;
}
For more information, refer to the mutation mode documentation →
hideText
hideText
is used to show or hide the text of the button. When true
, only the button icon is visible.
accessControl
This prop can be used to skip access control check with its enabled
property or to hide the button when the user does not have the permission to access the resource with hideIfUnauthorized
property. This is relevant only when an accessControlProvider
is provided to <Refine/>
import { DeleteButton } from "@refinedev/mui";
export const MyListComponent = () => {
return (
<DeleteButton
accessControl={{ enabled: true, hideIfUnauthorized: true }}
/>
);
};
resourceNameOrRouteName
deprecated
resourceNameOrRouteName
resourceNameOrRouteName
prop is deprecated. Useresource
prop instead.
resourceNameOrRouteName
allows us to manage which resource's record is going to be deleted.
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.
API Reference
Props
It also accepts all props of Material UI Button.