Skip to main content
UniversalCore
Version: 4.xx.xx
Swizzle Ready

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.

Good to know:

You can swizzle this component with the Refine CLI to customize it.

Usage​

const { Create } = RefineMui;
import dataProvider from "@refinedev/simple-rest";
// visible-block-start
import {
  useDataGrid,
  List,
  DeleteButton,
} from "@refinedev/mui";
import { DataGrid, GridColDef } from "@mui/x-data-grid";

const columns: GridColDef[] = [
  { field: "id", headerName: "ID", type: "number" },
  { field: "title", headerName: "Title", minWidth: 400, flex: 1 },
  {
    field: "actions",
    headerName: "Actions",
    renderCell: function render({ row }) {
      return <DeleteButton size="small" recordItemId={row.id} />;
    },
    align: "center",
    headerAlign: "center",
    minWidth: 80,
  },
];

const PostsList: React.FC = () => {
  const { dataGridProps } = useDataGrid<IPost>();

  return (
    <List>
      <DataGrid {...dataGridProps} columns={columns} autoHeight />
    </List>
  );
};

interface IPost {
  id: number;
  title: string;
}
// visible-block-end

const simpleRestDataProvider = dataProvider("https://api.fake-rest.refine.dev");

const customDataProvider = {
  ...simpleRestDataProvider,
  deleteOne: async ({ resource, id, variables }) => {
    await new Promise((resolve) => setTimeout(resolve, 500));

    return {
      message: "You have successfully deleted the record",
    };
  },
};

render(
  <RefineMuiDemo
    dataProvider={customDataProvider}
    resources={[
      {
        name: "posts",
        list: PostsList,
      },
    ]}
  />,
);

Properties​

recordItemId​

recordItemId allows us to manage which record will be deleted. By default, the recordItemId is inferred from the route params.

const { useRouterContext } = RefineCore;

import dataProvider from "@refinedev/simple-rest";

// visible-block-start
import { DeleteButton } from "@refinedev/mui";

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

// visible-block-end

const simpleRestDataProvider = dataProvider("https://api.fake-rest.refine.dev");

const customDataProvider = {
  ...simpleRestDataProvider,
  deleteOne: async ({ resource, id, variables }) => {
    await new Promise((resolve) => setTimeout(resolve, 500));

    return {
      message: "You have successfully deleted the record",
    };
  },
};

render(
  <RefineMuiDemo
    initialRoutes={["/"]}
    dataProvider={customDataProvider}
    resources={[
      {
        name: "posts",
      },
    ]}
    DashboardPage={MyDeleteComponent}
  />,
);

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

resource​

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

const { useRouterContext } = RefineCore;
import dataProvider from "@refinedev/simple-rest";

// visible-block-start
import { DeleteButton } from "@refinedev/mui";

const MyDeleteComponent = () => {
  return <DeleteButton resource="categories" recordItemId="2" />;
};
// visible-block-end
const simpleRestDataProvider = dataProvider("https://api.fake-rest.refine.dev");

const customDataProvider = {
  ...simpleRestDataProvider,
  deleteOne: async ({ resource, id, variables }) => {
    await new Promise((resolve) => setTimeout(resolve, 500));

    return {
      message: "You have successfully deleted the record",
    };
  },
};

render(
  <RefineMuiDemo
    initialRoutes={["/"]}
    dataProvider={customDataProvider}
    resources={[
      {
        name: "posts",
      },
      {
        name: "categories",
      },
    ]}
    DashboardPage={MyDeleteComponent}
  />,
);

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:

const { useRouterContext } = RefineCore;
import dataProvider from "@refinedev/simple-rest";

// visible-block-start
import { DeleteButton } from "@refinedev/mui";

const MyDeleteComponent = () => {
  return (
    <DeleteButton
      resource="posts"
      recordItemId="1"
      onSuccess={(value) => {
        console.log(value);
      }}
    />
  );
};
// visible-block-end
const simpleRestDataProvider = dataProvider("https://api.fake-rest.refine.dev");

const customDataProvider = {
  ...simpleRestDataProvider,
  deleteOne: async ({ resource, id, variables }) => {
    await new Promise((resolve) => setTimeout(resolve, 500));

    return {
      message: "You have successfully deleted the record",
    };
  },
};

render(
  <RefineMuiDemo
    initialRoutes={["/"]}
    dataProvider={customDataProvider}
    resources={[
      {
        name: "posts",
      },
    ]}
    DashboardPage={MyDeleteComponent}
  />,
);

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 { tableQuery } = useTable<IPost>();

  const { data } = tableQuery;

  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.

const { useRouterContext } = RefineCore;
import dataProvider from "@refinedev/simple-rest";

// visible-block-start
import { DeleteButton } from "@refinedev/mui";

const MyDeleteComponent = () => {
  return (
    <DeleteButton
      hideText={true}
    />
  );
};
// visible-block-end
const simpleRestDataProvider = dataProvider("https://api.fake-rest.refine.dev");

const customDataProvider = {
  ...simpleRestDataProvider,
  deleteOne: async ({ resource, id, variables }) => {
    await new Promise((resolve) => setTimeout(resolve, 500));

    return {
      message: "You have successfully deleted the record",
    };
  },
};

render(
  <RefineMuiDemo
    initialRoutes={["/"]}
    dataProvider={customDataProvider}
    resources={[
      {
        name: "posts",
        list: MyDeleteComponent,
      },
    ]}
  />,
);

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
​

Use resource prop instead.

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.

const { useRouterContext } = RefineCore;
import dataProvider from "@refinedev/simple-rest";

// visible-block-start
import { DeleteButton } from "@refinedev/mui";

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

const simpleRestDataProvider = dataProvider("https://api.fake-rest.refine.dev");

const customDataProvider = {
  ...simpleRestDataProvider,
  deleteOne: async ({ resource, id, variables }) => {
    await new Promise((resolve) => setTimeout(resolve, 500));

    return {
      message: "You have successfully deleted the record",
    };
  },
};

render(
  <RefineMuiDemo
    initialRoutes={["/"]}
    dataProvider={customDataProvider}
    resources={[
      {
        name: "posts",
        list: MyDeleteComponent,
      },
    ]}
  />,
);

API Reference​

Props​

External Props:

It also accepts all props of Material UI Button.

Previous
Create
Next
Edit