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

Delete

<DeleteButton> uses Mantine'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 with the Refine CLI to customize it.

Usage​

localhost:3000
import { List, DeleteButton } from "@refinedev/mantine";
import { Table, Pagination } from "@mantine/core";
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 size="xs" recordItemId={getValue() as number} />
          );
        },
      },
    ],
    [],
  );

  const {
    getHeaderGroups,
    getRowModel,
    refineCore: { setCurrent, pageCount, current },
  } = useTable({
    columns,
  });

  return (
    <List>
      <Table>
        <thead>
          {getHeaderGroups().map((headerGroup) => (
            <tr key={headerGroup.id}>
              {headerGroup.headers.map((header) => (
                <th key={header.id}>
                  {header.isPlaceholder
                    ? null
                    : flexRender(
                        header.column.columnDef.header,
                        header.getContext(),
                      )}
                </th>
              ))}
            </tr>
          ))}
        </thead>
        <tbody>
          {getRowModel().rows.map((row) => (
            <tr key={row.id}>
              {row.getVisibleCells().map((cell) => (
                <td key={cell.id}>
                  {flexRender(cell.column.columnDef.cell, cell.getContext())}
                </td>
              ))}
            </tr>
          ))}
        </tbody>
      </Table>
      <br />
      <Pagination
        position="right"
        total={pageCount}
        page={current}
        onChange={setCurrent}
      />
    </List>
  );
};

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

Properties​

recordItemId​

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

localhost:3000
import { DeleteButton } from "@refinedev/mantine";

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.

resource​

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

localhost:3000
import { DeleteButton } from "@refinedev/mantine";

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 "123" gets 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 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/mantine";

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

hideText​

It 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/mantine";

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

API Reference​

Properties​

Previous
Create
Next
Edit