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.

Swizzle

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

Usage

http://localhost:3000

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;
}

Properties

recordItemId

recordItemId allows us to manage which record will be deleted.

http://localhost:3000

import { DeleteButton } from "@refinedev/antd";

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

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.

resource

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

http://localhost:3000

import { DeleteButton } from "@refinedev/antd";

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

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:

http://localhost:3000

import { DeleteButton } from "@refinedev/antd";

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

mutationMode

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

Refer to the mutation mode docs for further information. →

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.

http://localhost:3000

import { DeleteButton } from "@refinedev/antd";

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

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

resourceNameOrRouteName prop is deprecated. Use resource prop instead.

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

http://localhost:3000

import { DeleteButton } from "@refinedev/antd";

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

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.

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.

http://localhost:3000

import { DeleteButton } from "@refinedev/antd";

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

API Reference

Properties

External Props

It also accepts all props of Ant Design Button.