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

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.

Good to know:

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

Usage​

// visible-block-start
import {
  List,
  useTable,
  DeleteButton,
} from "@refinedev/antd";
import { Table } from "antd";

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" width="50%" />
        <Table.Column<IPost>
          title="Actions"
          dataIndex="actions"
          key="actions"
          render={(_, record) => (
            <DeleteButton size="small" recordItemId={record.id} />
          )}
          width="50%"
        />
      </Table>
    </List>
  );
};

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

render(
  <RefineAntdDemo
    resources={[
      {
        name: "posts",
        list: PostList,
      },
    ]}
  />,
);

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;
// visible-block-start
import { DeleteButton } from "@refinedev/antd";

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

// visible-block-end

render(
  <RefineAntdDemo
    initialRoutes={["/"]}
    resources={[
      {
        name: "posts",
        list: () => {
          return <RefineAntd.List>List page here...</RefineAntd.List>;
        },
      },
    ]}
    DashboardPage={MyEditComponent}
  />,
);

Clicking the button will trigger the useDelete method and then the record whose resource is "posts" and whose id is "123" will be deleted.

resource​

resource allows us to manage which resource's record is going to be deleted. By default, the resource is inferred from the route params.

const { useRouterContext } = RefineCore;

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

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

// visible-block-end

render(
  <RefineAntdDemo
    initialRoutes={["/"]}
    resources={[
      {
        name: "posts",
        list: () => {
          return <RefineAntd.List>List page here...</RefineAntd.List>;
        },
      },
      {
        name: "categories",
        list: () => {
          return <RefineAntd.List>List page here...</RefineAntd.List>;
        },
      },
    ]}
    DashboardPage={MyDeleteComponent}
  />,
);

Clicking the button will trigger the useDelete method and then the record whose resource is "categories" and whose id is "2" will 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 something based on the results returned after the delete request.

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

setInitialRoutes(["/"]);
import { Refine } from "@refinedev/core";
import dataProvider from "@refinedev/simple-rest";

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

const MyDeleteComponent = () => {
  return (
    <DeleteButton
      resourceNameOrRouteName="posts"
      recordItemId="1"
      onSuccess={(value) => {
        console.log(value);
      }}
    />
  );
};
// visible-block-end

const App = () => {
  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",
      };
    },
  };

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

render(<App />);

mutationMode​

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

For more information, refer to the mutation mode documentation →

import { List, DeleteButton, useTable } from "@refinedev/antd";
import { Table } from "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.

const { useRouterContext } = RefineCore;

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

const MyDeleteComponent = () => {
  return (
    <DeleteButton
      recordItemId="123"
      hideText={true}
    />
  );
};

// visible-block-end

render(
  <RefineAntdDemo
    initialRoutes={["/"]}
    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/antd";

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 the confirmTitle prop, as well as what the 'ok' and 'cancel' buttons' text look like with the confirmOkText and confirmCancelText props.

const { useRouterContext } = RefineCore;

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

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

// visible-block-end

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

API Reference​

Properties​

External Props:

It also accepts all props of Ant Design Button.

Previous
Create
Next
Edit