Skip to main content
🧙‍♂️ refine grants your wishes! Please give us a ⭐️ on GitHub to keep the magic going.
Documentation
Version: 4.xx.xx
Swizzle Ready

Delete

<DeleteButton> uses Chakra UI's <Button> and <Popover> 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​

localhost:3000
import {
    List,
    DeleteButton,
} from "@refinedev/chakra-ui";
import {
    TableContainer,
    Table,
    Thead,
    Tr,
    Th,
    Tbody,
    Td,
} from "@chakra-ui/react";
import { useTable } from "@refinedev/react-table";
import { ColumnDef, flexRender } from "@tanstack/react-table";

const PostList: React.FC = () => {
    const columns = React.useMemo<ColumnDef<IPost>[]>(
        () => [
            {
                id: "id",
                header: "ID",
                accessorKey: "id",
            },
            {
                id: "title",
                header: "Title",
                accessorKey: "title",
            },
            {
                id: "actions",
                header: "Actions",
                accessorKey: "id",
                cell: function render({ getValue }) {
                    return (
                        <DeleteButton recordItemId={getValue() as number} />
                    );
                },
            },
        ],
        [],
    );

    const { getHeaderGroups, getRowModel } = useTable({
        columns,
    });

    return (
        <List>
            <TableContainer>
                <Table variant="simple" whiteSpace="pre-line">
                    <Thead>
                        {getHeaderGroups().map((headerGroup) => (
                            <Tr key={headerGroup.id}>
                                {headerGroup.headers.map((header) => {
                                    return (
                                        <Th key={header.id}>
                                            {!header.isPlaceholder &&
                                                flexRender(
                                                    header.column.columnDef
                                                        .header,
                                                    header.getContext(),
                                                )}
                                        </Th>
                                    );
                                })}
                            </Tr>
                        ))}
                    </Thead>
                    <Tbody>
                        {getRowModel().rows.map((row) => {
                            return (
                                <Tr key={row.id}>
                                    {row.getVisibleCells().map((cell) => {
                                        return (
                                            <Td key={cell.id}>
                                                {flexRender(
                                                    cell.column.columnDef.cell,
                                                    cell.getContext(),
                                                )}
                                            </Td>
                                        );
                                    })}
                                </Tr>
                            );
                        })}
                    </Tbody>
                </Table>
            </TableContainer>
        </List>
    );
};

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

Properties​

recordItemId​

recordItemId allows us to manage which record will be deleted.

localhost:3000
import { DeleteButton } from "@refinedev/chakra-ui";

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

Clicking the button will trigger the useDelete method and then the record whose resource is "post" and whose id is "123" 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.

localhost:3000
import { DeleteButton } from "@refinedev/chakra-ui";

const MyDeleteComponent = () => {
    return <DeleteButton resource="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.

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 based on the result returned after the delete request.

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

localhost:3000
import { DeleteButton } from "@refinedev/chakra-ui";

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

mutationMode​

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

localhost:3000
import { DeleteButton } from "@refinedev/chakra-ui";

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

For more information, refer to the mutation mode docsumentation →

hideText​

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

localhost:3000
import { DeleteButton } from "@refinedev/chakra-ui";

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

accessControl​

The accessControl prop can be used to skip the 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/chakra-ui";

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.

localhost:3000
import { DeleteButton } from "@refinedev/chakra-ui";

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.

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 the confirmOkText and confirmCancelText props.

localhost:3000
import { DeleteButton } from "@refinedev/chakra-ui";

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

API Reference​

Properties​

Previous
Create
Next
Edit